Menu

## Api
in package

Abstract Yes
Api.php : 11

API Helper to Arango HTTP Interface

##### Tags

copyright

  2018 Lucas S. Vieira

### Table of Contents

#### Constants

ADMIN_ENGINE = "/_api/engine"
ADMIN_FLUSH_WAL = "/_admin/wal/flush"
ADMIN_LOG = "/_admin/log"
ADMIN_LOG_LEVEL = "/_admin/log/level"
ADMIN_ROUTING_RELOAD = "/_admin/routing/reload"
ADMIN_SERVER_AVAILABILITY = "/_admin/server/availability"
ADMIN_SERVER_ROLE = "/_admin/server/role"
ADMIN_STATISTICS = "/_admin/statistics"
ADMIN_STATISTICS_DESCRIPTION = "/_admin/statistics-description"
ADMIN_TASKS = "/_api/tasks"
ADMIN_TIME = "/_admin/time"
ADMIN_VERSION = "/_api/version"
ADMIN_WAL_PROPERTIES = "_admin/wal/properties"
ADMIN_WAL_TRANSACTIONS = "_admin/wal/transactions"
ALL = "/_api/simple/all"
ALL_KEYS = "/_api/simple/all"
ANY = "/_api/simple/any"
AQL_USER_FUNCTION = "/_api/aqlfunction"
AUTH_BASE = "/_open/auth"
BATCH = "/_api/batch"
COLLECTION = "/_api/collection"
COLLECTION_CHECKSUM = "/checksum"
COLLECTION_COUNT = "/count"
COLLECTION_LOAD = "/load"
COLLECTION_PROPERTIES = "/properties"
COLLECTION_RECALCULATE_COUNT = "/recalculateCount"
COLLECTION_RENAME = "/rename"
COLLECTION_REVISION = "/revision"
COLLECTION_ROTATE = "/rotate"
COLLECTION_TRUNCATE = "/truncate"
CURRENT_DATABASE = "/_api/database/current"
CURSOR = "/_api/cursor"
DATABASE = "/_api/database"
DB = "/_db/"
DOCUMENT = "/_api/document"
EDGE = "/_api/document"
EDGES = "/_api/edges"
ENDPOINT = "/_api/endpoint"
EXAMPLE = "/_api/simple/by-example"
EXPLAIN = "/_api/explain"
FIRST_EXAMPLE = "/_api/simple/first-example"
FOXX = "/_api/foxx"
FOXX_SERVICE = "/_api/foxx/service"
FULLTEXT = "/_api/simple/fulltext"
GRAPH = "/_api/gharial"
IMPORT = "/_api/import"
INDEX = "/_api/index"
JWT_AUTH_BASE = "/_open/auth"
LOOKUP_BY_KEYS = "/_api/simple/lookup-by_keys"
PART_EDGE = "vertex"
PART_VERTEX = "vertex"
QUERY = "/_api/query"
QUERY_CACHE = "/_api/query-cache"
REMOVE_BY_EXAMPLE = "/_api/simple/remove-by-example"
REMOVE_BY_KEYS = "/_api/simple/remove-by-keys"
REPLACE_BY_EXAMPLE = "/_api/simple/replace-by-example"
TRANSACTION = "/_api/transaction"
TRANSACTION_BEGIN = "/_api/transaction/begin"
TRAVERSAL = "/_api/traversal"
UPDATE_BY_EXAMPLE = "/_api/simple/update-by-example"
UPLOAD = "/_api/upload"
USER = "/_api/user"
USER_DATABASES = "/_api/database/user"

#### Methods

addQuery() : string
  Add an URI query
addUriParam() : string
  Add an URI param to an URI
buildDatabaseUri() : string
  Builds URIs for access to Arango HTTP Interface
buildSystemUri() : string
  Builds URIs for access some special endpoints on Arango HTTP Interface

### Constants

#### ADMIN_ENGINE

Api.php : 65
`public mixed ADMIN_ENGINE = "/_api/engine"`

#### ADMIN_FLUSH_WAL

Api.php : 70
`public mixed ADMIN_FLUSH_WAL = "/_admin/wal/flush"`

#### ADMIN_LOG

Api.php : 69
`public mixed ADMIN_LOG = "/_admin/log"`

#### ADMIN_LOG_LEVEL

Api.php : 73
`public mixed ADMIN_LOG_LEVEL = "/_admin/log/level"`

#### ADMIN_ROUTING_RELOAD

Api.php : 74
`public mixed ADMIN_ROUTING_RELOAD = "/_admin/routing/reload"`

#### ADMIN_SERVER_AVAILABILITY

Api.php : 67
`public mixed ADMIN_SERVER_AVAILABILITY = "/_admin/server/availability"`

#### ADMIN_SERVER_ROLE

Api.php : 66
`public mixed ADMIN_SERVER_ROLE = "/_admin/server/role"`

#### ADMIN_STATISTICS

Api.php : 75
`public mixed ADMIN_STATISTICS = "/_admin/statistics"`

#### ADMIN_STATISTICS_DESCRIPTION

Api.php : 76
`public mixed ADMIN_STATISTICS_DESCRIPTION = "/_admin/statistics-description"`

#### ADMIN_TASKS

Api.php : 63
`public mixed ADMIN_TASKS = "/_api/tasks"`

#### ADMIN_TIME

Api.php : 68
`public mixed ADMIN_TIME = "/_admin/time"`

#### ADMIN_VERSION

Api.php : 64
`public mixed ADMIN_VERSION = "/_api/version"`

#### ADMIN_WAL_PROPERTIES

Api.php : 71
`public mixed ADMIN_WAL_PROPERTIES = "_admin/wal/properties"`

#### ADMIN_WAL_TRANSACTIONS

Api.php : 72
`public mixed ADMIN_WAL_TRANSACTIONS = "_admin/wal/transactions"`

#### ALL

Api.php : 51
`public mixed ALL = "/_api/simple/all"`

#### ALL_KEYS

Api.php : 52
`public mixed ALL_KEYS = "/_api/simple/all"`

#### ANY

Api.php : 53
`public mixed ANY = "/_api/simple/any"`

#### AQL_USER_FUNCTION

Api.php : 25
`public mixed AQL_USER_FUNCTION = "/_api/aqlfunction"`

#### AUTH_BASE

Api.php : 81
`public mixed AUTH_BASE = "/_open/auth"`

#### BATCH

Api.php : 21
`public mixed BATCH = "/_api/batch"`

#### COLLECTION

Api.php : 27
`public mixed COLLECTION = "/_api/collection"`

#### COLLECTION_CHECKSUM

Api.php : 32
`public mixed COLLECTION_CHECKSUM = "/checksum"`

#### COLLECTION_COUNT

Api.php : 29
`public mixed COLLECTION_COUNT = "/count"`

#### COLLECTION_LOAD

Api.php : 28
`public mixed COLLECTION_LOAD = "/load"`

#### COLLECTION_PROPERTIES

Api.php : 35
`public mixed COLLECTION_PROPERTIES = "/properties"`

#### COLLECTION_RECALCULATE_COUNT

Api.php : 36
`public mixed COLLECTION_RECALCULATE_COUNT = "/recalculateCount"`

#### COLLECTION_RENAME

Api.php : 30
`public mixed COLLECTION_RENAME = "/rename"`

#### COLLECTION_REVISION

Api.php : 33
`public mixed COLLECTION_REVISION = "/revision"`

#### COLLECTION_ROTATE

Api.php : 31
`public mixed COLLECTION_ROTATE = "/rotate"`

#### COLLECTION_TRUNCATE

Api.php : 34
`public mixed COLLECTION_TRUNCATE = "/truncate"`

#### CURRENT_DATABASE

Api.php : 42
`public mixed CURRENT_DATABASE = "/_api/database/current"`

#### CURSOR

Api.php : 18
`public mixed CURSOR = "/_api/cursor"`

#### DATABASE

Api.php : 41
`public mixed DATABASE = "/_api/database"`

#### DB

Api.php : 80
`public mixed DB = "/_db/"`

#### DOCUMENT

Api.php : 13
`public mixed DOCUMENT = "/_api/document"`

#### EDGE

Api.php : 14
`public mixed EDGE = "/_api/document"`

#### EDGES

Api.php : 15
`public mixed EDGES = "/_api/edges"`

#### ENDPOINT

Api.php : 40
`public mixed ENDPOINT = "/_api/endpoint"`

#### EXAMPLE

Api.php : 57
`public mixed EXAMPLE = "/_api/simple/by-example"`

#### EXPLAIN

Api.php : 20
`public mixed EXPLAIN = "/_api/explain"`

#### FIRST_EXAMPLE

Api.php : 58
`public mixed FIRST_EXAMPLE = "/_api/simple/first-example"`

#### FOXX

Api.php : 77
`public mixed FOXX = "/_api/foxx"`

#### FOXX_SERVICE

Api.php : 78
`public mixed FOXX_SERVICE = "/_api/foxx/service"`

#### FULLTEXT

Api.php : 54
`public mixed FULLTEXT = "/_api/simple/fulltext"`

#### GRAPH

Api.php : 16
`public mixed GRAPH = "/_api/gharial"`

#### IMPORT

Api.php : 19
`public mixed IMPORT = "/_api/import"`

#### INDEX

Api.php : 17
`public mixed INDEX = "/_api/index"`

#### JWT_AUTH_BASE

Api.php : 82
`public mixed JWT_AUTH_BASE = "/_open/auth"`

#### LOOKUP_BY_KEYS

Api.php : 50
`public mixed LOOKUP_BY_KEYS = "/_api/simple/lookup-by_keys"`

#### PART_EDGE

Api.php : 48
`public mixed PART_EDGE = "vertex"`

#### PART_VERTEX

Api.php : 47
`public mixed PART_VERTEX = "vertex"`

#### QUERY

Api.php : 22
`public mixed QUERY = "/_api/query"`

#### QUERY_CACHE

Api.php : 44
`public mixed QUERY_CACHE = "/_api/query-cache"`

#### REMOVE_BY_EXAMPLE

Api.php : 60
`public mixed REMOVE_BY_EXAMPLE = "/_api/simple/remove-by-example"`

#### REMOVE_BY_KEYS

Api.php : 55
`public mixed REMOVE_BY_KEYS = "/_api/simple/remove-by-keys"`

#### REPLACE_BY_EXAMPLE

Api.php : 61
`public mixed REPLACE_BY_EXAMPLE = "/_api/simple/replace-by-example"`

#### TRANSACTION

Api.php : 23
`public mixed TRANSACTION = "/_api/transaction"`

#### TRANSACTION_BEGIN

Api.php : 24
`public mixed TRANSACTION_BEGIN = "/_api/transaction/begin"`

#### TRAVERSAL

Api.php : 39
`public mixed TRAVERSAL = "/_api/traversal"`

#### UPDATE_BY_EXAMPLE

Api.php : 59
`public mixed UPDATE_BY_EXAMPLE = "/_api/simple/update-by-example"`

#### UPLOAD

Api.php : 45
`public mixed UPLOAD = "/_api/upload"`

#### USER

Api.php : 38
`public mixed USER = "/_api/user"`

#### USER_DATABASES

Api.php : 43
`public mixed USER_DATABASES = "/_api/database/user"`

### Methods

#### addQuery()

Api.php : 106

Add an URI query

`public static addQuery(string $baseUri[, array<string|int, mixed> $data = [] ]) : string`

##### Parameters

$baseUri : string

  Base URI to add a query.

$data : array<string|int, mixed> = []

  Query data.

##### Return values

string —

The modified URI with the Query.

#### addUriParam()

Api.php : 93

Add an URI param to an URI

`public static addUriParam(string $baseUri, string|int $param) : string`

##### Parameters

$baseUri : string

  Base URI to add a parameter.

$param : string|int

  Parameter value.

##### Return values

string —

The modified URI.

#### buildDatabaseUri()

Api.php : 120

Builds URIs for access to Arango HTTP Interface

`public static buildDatabaseUri(string $baseUri, string $database[, string $apiEndpoint = '' ]) : string`

##### Parameters

$baseUri : string

  Base URI to add a parameter.

$database : string

  Database name.

$apiEndpoint : string = ''

  Base Api endpoint (One of Api class constants).

##### Return values

string —

The modified database URI.

#### buildSystemUri()

Api.php : 133

Builds URIs for access some special endpoints on Arango HTTP Interface

`public static buildSystemUri(string $baseUri, string $endpoint) : string`

##### Parameters

$baseUri : string

  Base URI to add a parameter.

$endpoint : string

  One of Api class constants.

##### Return values

string —

The modified system URI.

## Search results