ArangoDB for API Implementors (1.3.1)

prev | home | next

• REST Interface for Documents
  • Documents, Identifiers, Handles
  • Address and ETag of a Document
  • Working with Documents using REST
    • GET /_api/document/document-handle
    • POST /_api/document?collection=collection-name
    • PUT /_api/document/document-handle
    • PATCH /_api/document/document-handle
    • DELETE /_api/document/document-handle
    • HEAD /_api/document/document-handle
    • GET /_api/document?collection=collection-name

• REST Interface for Edges
  • Documents, Identifiers, Handles
  • Address and ETag of an Edge
  • Working with Edges using REST
    • GET /_api/edge/document-handle
    • POST /_api/edge?collection=collection-name&from=from-handle&to=to-handle
    • PUT /_api/edge/document-handle
    • DELETE /_api/edge/document-handle
    • HEAD /_api/edge/document-handle
    • GET /_api/edges/collection-name?vertex=vertex-handle&directory=direction

• HTTP Interface for AQL Query Cursors
  • Database Cursors
  • Retrieving query results
    • Single roundtrip
    • Using a Cursor
  • Accessing Cursors via HTTP
    • POST /_api/cursor
    • POST /_api/query
    • PUT /_api/cursor/cursor-identifier
    • DELETE /_api/cursor/cursor-identifier

• HTTP Interface for AQL Queries
  • POST /_api/explain
  • POST /_api/query

• HTTP Interface for AQL User Functions Management
  • AQL User Functions Management
    • POST /_api/aqlfunction
    • DELETE /_api/aqlfunction/functionname
    • GET /_api/aqlfunction

• HTTP Interface for Simple Queries
  • Simple Queries
  • Working with Simples Queries using HTTP
    • PUT /_api/simple/all
    • PUT /_api/simple/by-example
    • PUT /_api/simple/first-example
    • PUT /_api/simple/any
    • PUT /_api/simple/range
    • PUT /_api/simple/near
    • PUT /_api/simple/within
    • PUT /_api/simple/fulltext
    • PUT /_api/simple/remove-by-example
    • PUT /_api/simple/replace-by-example
    • PUT /_api/simple/update-by-example

• HTTP Interface for Collections
  • Collections
  • Address of a Collection
  • Working with Collections using HTTP
    • Creating and Deleting Collections
      • POST /_api/collection
      • DELETE /_api/collection/collection-name
      • PUT /_api/collection/collection-name/truncate
    • Getting Information about a Collection
      • GET /_api/collection/collection-name
      • GET /_api/collection/collection-name/properties
      • GET /_api/collection/collection-name/count
      • GET /_api/collection/collection-name/figures
      • GET /_api/collection/collection-name/revision
      • GET /_api/collection/collection-name
      • GET /_api/collection/
    • Modifying a Collection
      • PUT /_api/collection/collection-name/load
      • PUT /_api/collection/collection-name/unload
      • PUT /_api/collection/collection-name/properties
      • PUT /_api/collection/collection-name/rename

• HTTP Interface for Indexes
  • Indexes
  • Address of an Index
  • Working with Indexes using HTTP
    • GET /_api/index/index-handle
    • POST /_api/index?collection=collection-name
    • DELETE /_api/index/index-handle
    • GET /_api/index?collection=index-handle

• Accessing Cap Constraints via Http
  • POST /_api/index

• Accessing Hash Indexes via Http
  • POST /_api/index
  • PUT /_api/simple/by-example
  • PUT /_api/simple/first-example

• Accessing Skip-List Indexes via Http
  • POST /_api/index
  • PUT /_api/simple/range

• Accessing Geo Indexes via Http
  • POST /_api/index
  • PUT /_api/simple/near
  • PUT /_api/simple/within

• Accessing Fulltext Indexes via Http
  • POST /_api/index
  • PUT /_api/simple/fulltext

• HTTP Interface for Transactions
  • Transactions
  • Executing Transactions via HTTP
    • POST /_api/transactions

• HTTP Interface for Graphs
  • POST /_api/graph
  • GET /_api/graph
  • DELETE /_api/graph
  • POST /_api/graph/graph-name/vertex
  • GET /_api/graph/graph-name/vertex
  • PUT /_api/graph/graph-name/vertex
  • PATCH /_api/graph/graph-name/vertex
  • DELETE /_api/graph/graph-name/vertex
  • POST /_api/graph/graph-name/vertices
  • POST /_api/graph/graph-name/edge
  • GET /_api/graph/graph-name/edge
  • PUT /_api/graph/graph-name/edge
  • PATCH /_api/graph/graph-name/edge
  • DELETE /_api/graph/graph-name/edge
  • POST /_api/graph/graph-name/edges

• HTTP Interface for bulk imports
  • Importing self-contained documents
  • Importing headers and values
  • Importing in edge collections

• HTTP Interface for Batch Requests

• HTTP Interface for Administration and Monitoring
  • GET /_admin/log
  • POST /_admin/routing/reload
  • POST /_admin/modules/flush
  • GET /_admin/statistics
  • GET /_admin/statistics-descriptions

• HTTP Interface for User Management
  • User Management
    • POST /_api/user
    • PUT /_api/user/username
    • PATCH /_api/user/username
    • DELETE /_api/user/username
    • GET /_api/user/username

• HTTP Interface for Miscellaneous functions
  • GET /_admin/version
  • GET /_admin/time
  • GET /_admin/echo

• HTTP Handling in ArangoDB
  • Keep-Alive and Authentication
  • Error Handling
  • Cross Origin Resource Sharing (CORS) requests

• Naming Conventions in ArangoDB
  • Collection Names
  • Document Keys
  • Attribute Names

• Error codes and meanings