Handling Edges

Examples will explain the REST API for manipulating edges of the graph module on the knows graph:

Social Example Graph

Create an edge

Creates an edge in an existing graph

POST /_api/gharial/{graph}/edge/{collection}

Creates a new edge in the collection. Within the body the edge has to contain a _from and _to value referencing to valid vertices in the graph. Furthermore the edge has to be valid in the definition of the used edge collection.

A JSON object with these properties is required:

  • _from: The source vertex of this edge. Has to be valid within the used edge definition.
  • _to: The target vertex of this edge. Has to be valid within the used edge definition.

HTTP 201 A json document with these Properties is returned:

Returned if the edge could be created and waitForSync is true.

  • edge:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • new:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.

HTTP 202 A json document with these Properties is returned:

Returned if the request was successful but waitForSync is false.

  • edge:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • new:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.

HTTP 400 A json document with these Properties is returned:

Returned if the input document is invalid. This can for instance be the case if _from or _to is mising.

  • errorMessage: A message created for this error.
  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

HTTP 403 A json document with these Properties is returned:

Returned if your user has insufficient rights. In order to insert edges into the graph you at least need to have the following privileges:

  1. Read Only access on the Database.
  2. Write access on the given collection.
  • errorMessage: A message created for this error.
  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

HTTP 404 A json document with these Properties is returned:

Returned in any of the following cases:

  • no graph with this name could be found.
  • this edge collection is not part of the graph.
  • either _from or _to vertex does not exist.

  • errorMessage: A message created for this error.

  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

Path Parameters

  • graph (required): The name of the graph.

  • collection (required): The name of the edge collection the edge belongs to.

Query Parameters

  • waitForSync (optional): Define if the request should wait until synced to disk.

  • returnNew (optional): Define if the response should contain the complete new version of the document.

Return Codes

  • 201: Returned if the edge could be created and waitForSync is true.

Response Body

  • new:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is false in this response.
  • edge:

    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • 202: Returned if the request was successful but waitForSync is false.

Response Body

  • new:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is false in this response.
  • edge:

    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • 400: Returned if the input document is invalid. This can for instance be the case if _from or _to is mising.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

  • 403: Returned if your user has insufficient rights. In order to insert edges into the graph you at least need to have the following privileges:

    1. Read Only access on the Database.
    2. Write access on the given collection.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

  • 404: Returned in any of the following cases:

  • no graph with this name could be found.
  • this edge collection is not part of the graph.
  • either _from or _to vertex does not exist.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

Examples

shell> curl -X POST --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation <<EOF
{ 
  "type" : "friend", 
  "_from" : "female/alice", 
  "_to" : "female/diana" 
}
EOF

HTTP/1.1 Accepted
content-type: application/json; charset=utf-8
etag: _YQtDYbm--F
x-content-type-options: nosniff

Show response body

Get an edge

fetch an edge

GET /_api/gharial/{graph}/edge/{collection}/{edge}

Gets an edge from the given collection.

HTTP 200 A json document with these Properties is returned:

Returned if the edge could be found.

  • edge:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is false in this response.

HTTP 304 A json document with these Properties is returned:

Returned if the if-none-match header is given and the currently stored edge still has this revision value. So there was no update between the last time the edge was fetched by the caller.

  • errorMessage: A message created for this error.
  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

HTTP 403 A json document with these Properties is returned:

Returned if your user has insufficient rights. In order to update vertices in the graph you at least need to have the following privileges:

  1. Read Only access on the Database.
  2. Read Only access on the given collection.
  • errorMessage: A message created for this error.
  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

HTTP 404 A json document with these Properties is returned:

Returned in the following cases:

  • No graph with this name could be found.
  • This collection is not part of the graph.
  • The edge does not exist.

  • errorMessage: A message created for this error.

  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

HTTP 412 A json document with these Properties is returned:

Returned if if-match header is given, but the stored documents revision is different.

  • errorMessage: A message created for this error.
  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

Path Parameters

  • graph (required): The name of the graph.

  • collection (required): The name of the edge collection the edge belongs to.

  • edge (required): The _key attribute of the edge.

Query Parameters

  • rev (optional): Must contain a revision. If this is set a document is only returned if it has exactly this revision. Also see if-match header as an alternative to this.

Header Parameters

  • if-match (optional): If the "If-Match" header is given, then it must contain exactly one Etag. The document is returned, if it has the same revision as the given Etag. Otherwise a HTTP 412 is returned. As an alternative you can supply the Etag in an attribute rev in the URL.

  • if-none-match (optional): If the "If-None-Match" header is given, then it must contain exactly one Etag. The document is returned, only if it has a different revision as the given Etag. Otherwise a HTTP 304 is returned.

Return Codes

  • 200: Returned if the edge could be found.

Response Body

  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is false in this response.
  • edge:

    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • 304: Returned if the if-none-match header is given and the currently stored edge still has this revision value. So there was no update between the last time the edge was fetched by the caller.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

  • 403: Returned if your user has insufficient rights. In order to update vertices in the graph you at least need to have the following privileges:

    1. Read Only access on the Database.
    2. Read Only access on the given collection.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

  • 404: Returned in the following cases:

  • No graph with this name could be found.
  • This collection is not part of the graph.
  • The edge does not exist.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

  • 412: Returned if if-match header is given, but the stored documents revision is different.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

Examples

shell> curl --header 'accept: application/json' --dump - http://localhost:8529/_api/gharial/social/edge/relation/101733

HTTP/1.1 OK
content-type: application/json; charset=utf-8
etag: _YQtDZGC--F
x-content-type-options: nosniff

Show response body

Examples will explain the API on the social graph:

Social Example Graph

Modify an edge

modify an existing edge

PATCH /_api/gharial/{graph}/edge/{collection}/{edge}

Updates the data of the specific edge in the collection.

HTTP 200 A json document with these Properties is returned:

Returned if the edge could be updated, and waitForSync is false.

  • edge:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • new:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.

HTTP 202 A json document with these Properties is returned:

Returned if the request was successful but waitForSync is false.

  • edge:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • new:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.

HTTP 403 A json document with these Properties is returned:

Returned if your user has insufficient rights. In order to update edges in the graph you at least need to have the following privileges:

  1. Read Only access on the Database.
  2. Write access on the given collection.
  • errorMessage: A message created for this error.
  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

HTTP 404 A json document with these Properties is returned:

Returned in the following cases:

  • No graph with this name could be found.
  • This collection is not part of the graph.
  • The edge to update does not exist.
  • either _from or _to vertex does not exist (if updated).

  • errorMessage: A message created for this error.

  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

HTTP 412 A json document with these Properties is returned:

Returned if if-match header is given, but the stored documents revision is different.

  • errorMessage: A message created for this error.
  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

Path Parameters

  • graph (required): The name of the graph.

  • collection (required): The name of the edge collection the edge belongs to.

  • edge (required): The _key attribute of the vertex.

Query Parameters

  • waitForSync (optional): Define if the request should wait until synced to disk.

  • keepNull (optional): Define if values set to null should be stored. By default (true) the given documents attribute(s) will be set to null. If this parameter is false the attribute(s) will instead be deleted from the document.

  • returnOld (optional): Define if a presentation of the deleted document should be returned within the response object.

  • returnNew (optional): Define if a presentation of the new document should be returned within the response object.

Header Parameters

  • if-match (optional): If the "If-Match" header is given, then it must contain exactly one Etag. The document is updated, if it has the same revision as the given Etag. Otherwise a HTTP 412 is returned. As an alternative you can supply the Etag in an attribute rev in the URL.

Request Body (required)

The body has to contain a JSON object containing exactly the attributes that should be overwritten, all other attributes remain unchanged.

Return Codes

  • 200: Returned if the edge could be updated, and waitForSync is false.

Response Body

  • new:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.
  • edge:

    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • 202: Returned if the request was successful but waitForSync is false.

Response Body

  • new:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.
  • edge:

    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • 403: Returned if your user has insufficient rights. In order to update edges in the graph you at least need to have the following privileges:

    1. Read Only access on the Database.
    2. Write access on the given collection.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

  • 404: Returned in the following cases:

  • No graph with this name could be found.
  • This collection is not part of the graph.
  • The edge to update does not exist.
  • either _from or _to vertex does not exist (if updated).

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

  • 412: Returned if if-match header is given, but the stored documents revision is different.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

Examples

shell> curl -X PATCH --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/102346 <<EOF
{ 
  "since" : "01.01.2001" 
}
EOF

HTTP/1.1 Accepted
content-type: application/json; charset=utf-8
etag: _YQtDZkq--B
x-content-type-options: nosniff

Show response body

Replace an edge

replace the content of an existing edge

PUT /_api/gharial/{graph}/edge/{collection}/{edge}

Replaces the data of an edge in the collection.

A JSON object with these properties is required:

  • _from: The source vertex of this edge. Has to be valid within the used edge definition.
  • _to: The target vertex of this edge. Has to be valid within the used edge definition.

HTTP 201 A json document with these Properties is returned:

Returned if the request was successful but waitForSync is true.

  • edge:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • new:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.

HTTP 202 A json document with these Properties is returned:

Returned if the request was successful but waitForSync is false.

  • edge:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • new:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.

HTTP 403 A json document with these Properties is returned:

Returned if your user has insufficient rights. In order to replace edges in the graph you at least need to have the following privileges:

  1. Read Only access on the Database.
  2. Write access on the given collection.
  • errorMessage: A message created for this error.
  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

HTTP 404 A json document with these Properties is returned:

Returned in the following cases:

  • No graph with this name could be found.
  • This collection is not part of the graph.
  • The edge to replace does not exist.
  • either _from or _to vertex does not exist.

  • errorMessage: A message created for this error.

  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

HTTP 412 A json document with these Properties is returned:

Returned if if-match header is given, but the stored documents revision is different.

  • errorMessage: A message created for this error.
  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

Path Parameters

  • graph (required): The name of the graph.

  • collection (required): The name of the edge collection the edge belongs to.

  • edge (required): The _key attribute of the vertex.

Query Parameters

  • waitForSync (optional): Define if the request should wait until synced to disk.

  • keepNull (optional): Define if values set to null should be stored. By default the key is not removed from the document.

  • returnOld (optional): Define if a presentation of the deleted document should be returned within the response object.

  • returnNew (optional): Define if a presentation of the new document should be returned within the response object.

Header Parameters

  • if-match (optional): If the "If-Match" header is given, then it must contain exactly one Etag. The document is updated, if it has the same revision as the given Etag. Otherwise a HTTP 412 is returned. As an alternative you can supply the Etag in an attribute rev in the URL.

Return Codes

  • 201: Returned if the request was successful but waitForSync is true.

Response Body

  • new:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.
  • edge:

    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • 202: Returned if the request was successful but waitForSync is false.

Response Body

  • new:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.
  • edge:

    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • 403: Returned if your user has insufficient rights. In order to replace edges in the graph you at least need to have the following privileges:

    1. Read Only access on the Database.
    2. Write access on the given collection.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

  • 404: Returned in the following cases:

  • No graph with this name could be found.
  • This collection is not part of the graph.
  • The edge to replace does not exist.
  • either _from or _to vertex does not exist.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

  • 412: Returned if if-match header is given, but the stored documents revision is different.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

Examples

shell> curl -X PUT --header 'accept: application/json' --data-binary @- --dump - http://localhost:8529/_api/gharial/social/edge/relation/102417 <<EOF
{ 
  "type" : "divorced", 
  "_from" : "female/alice", 
  "_to" : "male/bob" 
}
EOF

HTTP/1.1 Accepted
content-type: application/json; charset=utf-8
etag: _YQtDZn6--_
x-content-type-options: nosniff

Show response body

Remove an edge

removes an edge from graph

DELETE /_api/gharial/{graph}/edge/{collection}/{edge}

Removes an edge from the collection.

HTTP 200 A json document with these Properties is returned:

Returned if the edge could be removed.

  • removed: Is set to true if the remove was successful.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.

HTTP 202 A json document with these Properties is returned:

Returned if the request was successful but waitForSync is false.

  • removed: Is set to true if the remove was successful.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _rev: The _rev value of the stored data.
    • _id: The _id value of the stored data.
    • _from: The _from value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.

HTTP 403 A json document with these Properties is returned:

Returned if your user has insufficient rights. In order to delete vertices in the graph you at least need to have the following privileges:

  1. Read Only access on the Database.
  2. Write access on the given collection.
  • errorMessage: A message created for this error.
  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

HTTP 404 A json document with these Properties is returned:

Returned in the following cases:

  • No graph with this name could be found.
  • This collection is not part of the graph.
  • The edge to remove does not exist.

  • errorMessage: A message created for this error.

  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

HTTP 412 A json document with these Properties is returned:

Returned if if-match header is given, but the stored documents revision is different.

  • errorMessage: A message created for this error.
  • errorNum: ArangoDB error number for the error that occured.
  • code: The response code.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

Path Parameters

  • graph (required): The name of the graph.

  • collection (required): The name of the edge collection the edge belongs to.

  • edge (required): The _key attribute of the edge.

Query Parameters

  • waitForSync (optional): Define if the request should wait until synced to disk.

  • returnOld (optional): Define if a presentation of the deleted document should be returned within the response object.

Header Parameters

  • if-match (optional): If the "If-Match" header is given, then it must contain exactly one Etag. The document is updated, if it has the same revision as the given Etag. Otherwise a HTTP 412 is returned. As an alternative you can supply the Etag in an attribute rev in the URL.

Return Codes

  • 200: Returned if the edge could be removed.

Response Body

  • removed: Is set to true if the remove was successful.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.

  • 202: Returned if the request was successful but waitForSync is false.

Response Body

  • removed: Is set to true if the remove was successful.
  • code: The response code.
  • old:
    • _key: The _key value of the stored data.
    • _from: The _from value of the stored data.
    • _id: The _id value of the stored data.
    • _rev: The _rev value of the stored data.
    • _to: The _to value of the stored data.
  • error: Flag if there was an error (true) or not (false). It is false in this response.

  • 403: Returned if your user has insufficient rights. In order to delete vertices in the graph you at least need to have the following privileges:

    1. Read Only access on the Database.
    2. Write access on the given collection.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

  • 404: Returned in the following cases:

  • No graph with this name could be found.
  • This collection is not part of the graph.
  • The edge to remove does not exist.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

  • 412: Returned if if-match header is given, but the stored documents revision is different.

Response Body

  • errorMessage: A message created for this error.
  • code: The response code.
  • errorNum: ArangoDB error number for the error that occured.
  • error: Flag if there was an error (true) or not (false). It is true in this response.

Examples

shell> curl -X DELETE --header 'accept: application/json' --dump - http://localhost:8529/_api/gharial/social/edge/relation/101420

HTTP/1.1 Accepted
content-type: application/json; charset=utf-8
x-content-type-options: nosniff

Show response body