HTTP Interface for Traversals

Traversals

ArangoDB's graph traversals are executed on the server. Traversals can be initiated by clients by sending the traversal description for execution to the server.

Traversals in ArangoDB are used to walk over a graph stored in one edge collection. It can easily be described which edges of the graph should be followed and which actions should be performed on each visited vertex. Furthermore the ordering of visiting the nodes can be specified, for instance depth-first or breadth-first search are offered.

Executing Traversals via HTTP

executes a traversal

execute a server-side traversal

POST /_api/traversal

Starts a traversal starting from a given vertex and following. edges contained in a given edgeCollection. The request must contain the following attributes.

A json post document with these Properties is required:

  • sort: body (JavaScript) code of a custom comparison function for the edges. The signature of this function is (l, r) -> integer (where l and r are edges) and must return -1 if l is smaller than, +1 if l is greater than, and 0 if l and r are equal. The reason for this is the following: The order of edges returned for a certain vertex is undefined. This is because there is no natural order of edges for a vertex with multiple connected edges. To explicitly define the order in which edges on the vertex are followed, you can specify an edge comparator function with this attribute. Note that the value here has to be a string to conform to the JSON standard, which in turn is parsed as function body on the server side. Furthermore note that this attribute is only used for the standard expanders. If you use your custom expander you have to do the sorting yourself within the expander code.
  • direction: direction for traversal
    • if set, must be either "outbound", "inbound", or "any"
    • if not set, the expander attribute must be specified
  • minDepth: ANDed with any existing filters): visits only nodes in at least the given depth
  • startVertex: id of the startVertex, e.g. "users/foo".
  • visitor: body (JavaScript) code of custom visitor function function signature: (config, result, vertex, path, connected) -> void The visitor function can do anything, but its return value is ignored. To populate a result, use the result variable by reference. Note that the connected argument is only populated when the order attribute is set to "preorder-expander".
  • itemOrder: item iteration order can be "forward" or "backward"
  • strategy: traversal strategy can be "depthfirst" or "breadthfirst"
  • filter: default is to include all nodes: body (JavaScript code) of custom filter function function signature: (config, vertex, path) -> mixed can return four different string values:
    • "exclude" -> this vertex will not be visited.
    • "prune" -> the edges of this vertex will not be followed.
    • "" or undefined -> visit the vertex and follow it's edges.
    • Array -> containing any combination of the above. If there is at least one "exclude" or "prune" respectivly is contained, it's effect will occur.
  • init: body (JavaScript) code of custom result initialization function function signature: (config, result) -> void initialize any values in result with what is required
  • maxIterations: Maximum number of iterations in each traversal. This number can be set to prevent endless loops in traversal of cyclic graphs. When a traversal performs as many iterations as the maxIterations value, the traversal will abort with an error. If maxIterations is not set, a server-defined value may be used.
  • maxDepth: ANDed with any existing filters visits only nodes in at most the given depth
  • uniqueness: specifies uniqueness for vertices and edges visited. If set, must be an object like this: "uniqueness": {"vertices": "none"|"global"|"path", "edges": "none"|"global"|"path"}
  • order: traversal order can be "preorder", "postorder" or "preorder-expander"
  • graphName: name of the graph that contains the edges. Either edgeCollection or graphName has to be given. In case both values are set the graphName is prefered.
  • expander: body (JavaScript) code of custom expander function must be set if direction attribute is not set function signature: (config, vertex, path) -> array expander must return an array of the connections for vertex each connection is an object with the attributes edge and vertex
  • edgeCollection: name of the collection that contains the edges.

If the Traversal is successfully executed HTTP 200 will be returned. Additionally the result object will be returned by the traversal.

For successful traversals, the returned JSON object has the following properties:

  • error: boolean flag to indicate if an error occurred (false in this case)

  • code: the HTTP status code

  • result: the return value of the traversal

If the traversal specification is either missing or malformed, the server will respond with HTTP 400.

The body of the response will then contain a JSON object with additional error details. The object has the following attributes:

  • error: boolean flag to indicate that an error occurred (true in this case)

  • code: the HTTP status code

  • errorNum: the server error number

  • errorMessage: a descriptive error message

Example:

In the following examples the underlying graph will contain five persons Alice, Bob, Charlie, Dave and Eve. We will have the following directed relations:

  • Alice knows Bob
  • Bob knows Charlie
  • Bob knows Dave
  • Eve knows Alice
  • Eve knows Bob

The starting vertex will always be Alice.

Follow only outbound edges

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu6685a---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu6685a--_", 
          "name" : "Bob" 
        }, 
        { 
          "_key" : "charlie", 
          "_id" : "persons/charlie", 
          "_rev" : "_Uu6685a--A", 
          "name" : "Charlie" 
        }, 
        { 
          "_key" : "dave", 
          "_id" : "persons/dave", 
          "_rev" : "_Uu6685e---", 
          "name" : "Dave" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6685a---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11893", 
              "_id" : "knows/11893", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu6685e--A" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6685a---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6685a--_", 
              "name" : "Bob" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11893", 
              "_id" : "knows/11893", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu6685e--A" 
            }, 
            { 
              "_key" : "11897", 
              "_id" : "knows/11897", 
              "_from" : "persons/bob", 
              "_to" : "persons/charlie", 
              "_rev" : "_Uu6685i---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6685a---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6685a--_", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "charlie", 
              "_id" : "persons/charlie", 
              "_rev" : "_Uu6685a--A", 
              "name" : "Charlie" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11893", 
              "_id" : "knows/11893", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu6685e--A" 
            }, 
            { 
              "_key" : "11900", 
              "_id" : "knows/11900", 
              "_from" : "persons/bob", 
              "_to" : "persons/dave", 
              "_rev" : "_Uu6685i--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6685a---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6685a--_", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "dave", 
              "_id" : "persons/dave", 
              "_rev" : "_Uu6685e---", 
              "name" : "Dave" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Follow only inbound edges

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "inbound" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu6673y---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "eve", 
          "_id" : "persons/eve", 
          "_rev" : "_Uu66732--_", 
          "name" : "Eve" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6673y---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11656", 
              "_id" : "knows/11656", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu6674---_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6673y---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu66732--_", 
              "name" : "Eve" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Follow any direction of edges

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "uniqueness" : { 
    "vertices" : "none", 
    "edges" : "global" 
  } 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu666UK---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu666UO---", 
          "name" : "Bob" 
        }, 
        { 
          "_key" : "charlie", 
          "_id" : "persons/charlie", 
          "_rev" : "_Uu666US---", 
          "name" : "Charlie" 
        }, 
        { 
          "_key" : "dave", 
          "_id" : "persons/dave", 
          "_rev" : "_Uu666US--_", 
          "name" : "Dave" 
        }, 
        { 
          "_key" : "eve", 
          "_id" : "persons/eve", 
          "_rev" : "_Uu666UW---", 
          "name" : "Eve" 
        }, 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu666UK---", 
          "name" : "Alice" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666UK---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11235", 
              "_id" : "knows/11235", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666Ua---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666UK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666UO---", 
              "name" : "Bob" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11235", 
              "_id" : "knows/11235", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666Ua---" 
            }, 
            { 
              "_key" : "11239", 
              "_id" : "knows/11239", 
              "_from" : "persons/bob", 
              "_to" : "persons/charlie", 
              "_rev" : "_Uu666Ue---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666UK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666UO---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "charlie", 
              "_id" : "persons/charlie", 
              "_rev" : "_Uu666US---", 
              "name" : "Charlie" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11235", 
              "_id" : "knows/11235", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666Ua---" 
            }, 
            { 
              "_key" : "11242", 
              "_id" : "knows/11242", 
              "_from" : "persons/bob", 
              "_to" : "persons/dave", 
              "_rev" : "_Uu666Ue--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666UK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666UO---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "dave", 
              "_id" : "persons/dave", 
              "_rev" : "_Uu666US--_", 
              "name" : "Dave" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11235", 
              "_id" : "knows/11235", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666Ua---" 
            }, 
            { 
              "_key" : "11248", 
              "_id" : "knows/11248", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666Ui---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666UK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666UO---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu666UW---", 
              "name" : "Eve" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11235", 
              "_id" : "knows/11235", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666Ua---" 
            }, 
            { 
              "_key" : "11248", 
              "_id" : "knows/11248", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666Ui---" 
            }, 
            { 
              "_key" : "11245", 
              "_id" : "knows/11245", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu666Ue--A" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666UK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666UO---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu666UW---", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666UK---", 
              "name" : "Alice" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Excluding Charlie and Bob

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "filter" : "if (vertex.name === \"Bob\" ||     vertex.name === \"Charlie\") {  return \"exclude\";}return;" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu667ZS---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "dave", 
          "_id" : "persons/dave", 
          "_rev" : "_Uu667ZW--_", 
          "name" : "Dave" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu667ZS---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11537", 
              "_id" : "knows/11537", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu667Za--_" 
            }, 
            { 
              "_key" : "11544", 
              "_id" : "knows/11544", 
              "_from" : "persons/bob", 
              "_to" : "persons/dave", 
              "_rev" : "_Uu667Ze--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu667ZS---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu667ZS--_", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "dave", 
              "_id" : "persons/dave", 
              "_rev" : "_Uu667ZW--_", 
              "name" : "Dave" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Do not follow edges from Bob

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "filter" : "if (vertex.name === \"Bob\") {return \"prune\";}return;" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu667ne---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu667ni---", 
          "name" : "Bob" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu667ne---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11594", 
              "_id" : "knows/11594", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu667nq---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu667ne---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu667ni---", 
              "name" : "Bob" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Visit only nodes in a depth of at least 2

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "minDepth" : 2 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "charlie", 
          "_id" : "persons/charlie", 
          "_rev" : "_Uu668pq--_", 
          "name" : "Charlie" 
        }, 
        { 
          "_key" : "dave", 
          "_id" : "persons/dave", 
          "_rev" : "_Uu668pu---", 
          "name" : "Dave" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ 
            { 
              "_key" : "11836", 
              "_id" : "knows/11836", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu668pu--A" 
            }, 
            { 
              "_key" : "11840", 
              "_id" : "knows/11840", 
              "_from" : "persons/bob", 
              "_to" : "persons/charlie", 
              "_rev" : "_Uu668py---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu668pm---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu668pq---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "charlie", 
              "_id" : "persons/charlie", 
              "_rev" : "_Uu668pq--_", 
              "name" : "Charlie" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11836", 
              "_id" : "knows/11836", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu668pu--A" 
            }, 
            { 
              "_key" : "11843", 
              "_id" : "knows/11843", 
              "_from" : "persons/bob", 
              "_to" : "persons/dave", 
              "_rev" : "_Uu668py--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu668pm---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu668pq---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "dave", 
              "_id" : "persons/dave", 
              "_rev" : "_Uu668pu---", 
              "name" : "Dave" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Visit only nodes in a depth of at most 1

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "maxDepth" : 1 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu668JG---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu668JG--_", 
          "name" : "Bob" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu668JG---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11699", 
              "_id" : "knows/11699", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu668JO---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu668JG---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu668JG--_", 
              "name" : "Bob" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Using a visitor function to return vertex ids only

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "visitor" : "result.visited.vertices.push(vertex._id);" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        "persons/alice", 
        "persons/bob", 
        "persons/charlie", 
        "persons/dave" 
      ], 
      "paths" : [ ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Count all visited nodes and return a list of nodes only

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "init" : "result.visited = 0; result.myVertices = [ ];", 
  "visitor" : "result.visited++; result.myVertices.push(vertex);" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : 4, 
    "myVertices" : [ 
      { 
        "_key" : "alice", 
        "_id" : "persons/alice", 
        "_rev" : "_Uu669Y6---", 
        "name" : "Alice" 
      }, 
      { 
        "_key" : "bob", 
        "_id" : "persons/bob", 
        "_rev" : "_Uu669Y6--_", 
        "name" : "Bob" 
      }, 
      { 
        "_key" : "charlie", 
        "_id" : "persons/charlie", 
        "_rev" : "_Uu669Y6--A", 
        "name" : "Charlie" 
      }, 
      { 
        "_key" : "dave", 
        "_id" : "persons/dave", 
        "_rev" : "_Uu669Z----", 
        "name" : "Dave" 
      } 
    ] 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Expand only inbound edges of Alice and outbound edges of Eve

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "expander" : "var connections = [ ];if (vertex.name === \"Alice\") {config.datasource.getInEdges(vertex).forEach(function (e) {connections.push({ vertex: require(\"internal\").db._document(e._from), edge: e});});}if (vertex.name === \"Eve\") {config.datasource.getOutEdges(vertex).forEach(function (e) {connections.push({vertex: require(\"internal\").db._document(e._to), edge: e});});}return connections;" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu669pO---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "eve", 
          "_id" : "persons/eve", 
          "_rev" : "_Uu669pS--A", 
          "name" : "Eve" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu669pO--_", 
          "name" : "Bob" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669pO---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "12100", 
              "_id" : "knows/12100", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu669pa--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669pO---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu669pS--A", 
              "name" : "Eve" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "12100", 
              "_id" : "knows/12100", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu669pa--_" 
            }, 
            { 
              "_key" : "12103", 
              "_id" : "knows/12103", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669pa--A" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669pO---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu669pS--A", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu669pO--_", 
              "name" : "Bob" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Follow the depthfirst strategy

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "strategy" : "depthfirst" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu6665u---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu6665y---", 
          "name" : "Bob" 
        }, 
        { 
          "_key" : "charlie", 
          "_id" : "persons/charlie", 
          "_rev" : "_Uu6665y--_", 
          "name" : "Charlie" 
        }, 
        { 
          "_key" : "dave", 
          "_id" : "persons/dave", 
          "_rev" : "_Uu66652---", 
          "name" : "Dave" 
        }, 
        { 
          "_key" : "eve", 
          "_id" : "persons/eve", 
          "_rev" : "_Uu66652--_", 
          "name" : "Eve" 
        }, 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu6665u---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "eve", 
          "_id" : "persons/eve", 
          "_rev" : "_Uu66652--_", 
          "name" : "Eve" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu6665y---", 
          "name" : "Bob" 
        }, 
        { 
          "_key" : "charlie", 
          "_id" : "persons/charlie", 
          "_rev" : "_Uu6665y--_", 
          "name" : "Charlie" 
        }, 
        { 
          "_key" : "dave", 
          "_id" : "persons/dave", 
          "_rev" : "_Uu66652---", 
          "name" : "Dave" 
        }, 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu6665u---", 
          "name" : "Alice" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11386", 
              "_id" : "knows/11386", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu66656---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6665y---", 
              "name" : "Bob" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11386", 
              "_id" : "knows/11386", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu66656---" 
            }, 
            { 
              "_key" : "11390", 
              "_id" : "knows/11390", 
              "_from" : "persons/bob", 
              "_to" : "persons/charlie", 
              "_rev" : "_Uu66656--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6665y---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "charlie", 
              "_id" : "persons/charlie", 
              "_rev" : "_Uu6665y--_", 
              "name" : "Charlie" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11386", 
              "_id" : "knows/11386", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu66656---" 
            }, 
            { 
              "_key" : "11393", 
              "_id" : "knows/11393", 
              "_from" : "persons/bob", 
              "_to" : "persons/dave", 
              "_rev" : "_Uu66656--A" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6665y---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "dave", 
              "_id" : "persons/dave", 
              "_rev" : "_Uu66652---", 
              "name" : "Dave" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11386", 
              "_id" : "knows/11386", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu66656---" 
            }, 
            { 
              "_key" : "11399", 
              "_id" : "knows/11399", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu6666---_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6665y---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu66652--_", 
              "name" : "Eve" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11386", 
              "_id" : "knows/11386", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu66656---" 
            }, 
            { 
              "_key" : "11399", 
              "_id" : "knows/11399", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu6666---_" 
            }, 
            { 
              "_key" : "11396", 
              "_id" : "knows/11396", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu6666----" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6665y---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu66652--_", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11396", 
              "_id" : "knows/11396", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu6666----" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu66652--_", 
              "name" : "Eve" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11396", 
              "_id" : "knows/11396", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu6666----" 
            }, 
            { 
              "_key" : "11399", 
              "_id" : "knows/11399", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu6666---_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu66652--_", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6665y---", 
              "name" : "Bob" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11396", 
              "_id" : "knows/11396", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu6666----" 
            }, 
            { 
              "_key" : "11399", 
              "_id" : "knows/11399", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu6666---_" 
            }, 
            { 
              "_key" : "11390", 
              "_id" : "knows/11390", 
              "_from" : "persons/bob", 
              "_to" : "persons/charlie", 
              "_rev" : "_Uu66656--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu66652--_", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6665y---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "charlie", 
              "_id" : "persons/charlie", 
              "_rev" : "_Uu6665y--_", 
              "name" : "Charlie" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11396", 
              "_id" : "knows/11396", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu6666----" 
            }, 
            { 
              "_key" : "11399", 
              "_id" : "knows/11399", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu6666---_" 
            }, 
            { 
              "_key" : "11393", 
              "_id" : "knows/11393", 
              "_from" : "persons/bob", 
              "_to" : "persons/dave", 
              "_rev" : "_Uu66656--A" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu66652--_", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6665y---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "dave", 
              "_id" : "persons/dave", 
              "_rev" : "_Uu66652---", 
              "name" : "Dave" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11396", 
              "_id" : "knows/11396", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu6666----" 
            }, 
            { 
              "_key" : "11399", 
              "_id" : "knows/11399", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu6666---_" 
            }, 
            { 
              "_key" : "11386", 
              "_id" : "knows/11386", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu66656---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu66652--_", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu6665y---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu6665u---", 
              "name" : "Alice" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Using postorder ordering

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "order" : "postorder" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "charlie", 
          "_id" : "persons/charlie", 
          "_rev" : "_Uu669IO--_", 
          "name" : "Charlie" 
        }, 
        { 
          "_key" : "dave", 
          "_id" : "persons/dave", 
          "_rev" : "_Uu669IO--A", 
          "name" : "Dave" 
        }, 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu669IK---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "eve", 
          "_id" : "persons/eve", 
          "_rev" : "_Uu669IS---", 
          "name" : "Eve" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu669IO---", 
          "name" : "Bob" 
        }, 
        { 
          "_key" : "charlie", 
          "_id" : "persons/charlie", 
          "_rev" : "_Uu669IO--_", 
          "name" : "Charlie" 
        }, 
        { 
          "_key" : "dave", 
          "_id" : "persons/dave", 
          "_rev" : "_Uu669IO--A", 
          "name" : "Dave" 
        }, 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu669IK---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu669IO---", 
          "name" : "Bob" 
        }, 
        { 
          "_key" : "eve", 
          "_id" : "persons/eve", 
          "_rev" : "_Uu669IS---", 
          "name" : "Eve" 
        }, 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu669IK---", 
          "name" : "Alice" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ 
            { 
              "_key" : "11950", 
              "_id" : "knows/11950", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669IS--_" 
            }, 
            { 
              "_key" : "11954", 
              "_id" : "knows/11954", 
              "_from" : "persons/bob", 
              "_to" : "persons/charlie", 
              "_rev" : "_Uu669IW---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu669IO---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "charlie", 
              "_id" : "persons/charlie", 
              "_rev" : "_Uu669IO--_", 
              "name" : "Charlie" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11950", 
              "_id" : "knows/11950", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669IS--_" 
            }, 
            { 
              "_key" : "11957", 
              "_id" : "knows/11957", 
              "_from" : "persons/bob", 
              "_to" : "persons/dave", 
              "_rev" : "_Uu669IW--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu669IO---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "dave", 
              "_id" : "persons/dave", 
              "_rev" : "_Uu669IO--A", 
              "name" : "Dave" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11950", 
              "_id" : "knows/11950", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669IS--_" 
            }, 
            { 
              "_key" : "11963", 
              "_id" : "knows/11963", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669Ia--_" 
            }, 
            { 
              "_key" : "11960", 
              "_id" : "knows/11960", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu669Ia---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu669IO---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu669IS---", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11950", 
              "_id" : "knows/11950", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669IS--_" 
            }, 
            { 
              "_key" : "11963", 
              "_id" : "knows/11963", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669Ia--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu669IO---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu669IS---", 
              "name" : "Eve" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11950", 
              "_id" : "knows/11950", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669IS--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu669IO---", 
              "name" : "Bob" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11960", 
              "_id" : "knows/11960", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu669Ia---" 
            }, 
            { 
              "_key" : "11963", 
              "_id" : "knows/11963", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669Ia--_" 
            }, 
            { 
              "_key" : "11954", 
              "_id" : "knows/11954", 
              "_from" : "persons/bob", 
              "_to" : "persons/charlie", 
              "_rev" : "_Uu669IW---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu669IS---", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu669IO---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "charlie", 
              "_id" : "persons/charlie", 
              "_rev" : "_Uu669IO--_", 
              "name" : "Charlie" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11960", 
              "_id" : "knows/11960", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu669Ia---" 
            }, 
            { 
              "_key" : "11963", 
              "_id" : "knows/11963", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669Ia--_" 
            }, 
            { 
              "_key" : "11957", 
              "_id" : "knows/11957", 
              "_from" : "persons/bob", 
              "_to" : "persons/dave", 
              "_rev" : "_Uu669IW--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu669IS---", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu669IO---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "dave", 
              "_id" : "persons/dave", 
              "_rev" : "_Uu669IO--A", 
              "name" : "Dave" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11960", 
              "_id" : "knows/11960", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu669Ia---" 
            }, 
            { 
              "_key" : "11963", 
              "_id" : "knows/11963", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669Ia--_" 
            }, 
            { 
              "_key" : "11950", 
              "_id" : "knows/11950", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669IS--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu669IS---", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu669IO---", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11960", 
              "_id" : "knows/11960", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu669Ia---" 
            }, 
            { 
              "_key" : "11963", 
              "_id" : "knows/11963", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu669Ia--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu669IS---", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu669IO---", 
              "name" : "Bob" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11960", 
              "_id" : "knows/11960", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu669Ia---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu669IS---", 
              "name" : "Eve" 
            } 
          ] 
        }, 
        { 
          "edges" : [ ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu669IK---", 
              "name" : "Alice" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Using backward item-ordering:

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "itemOrder" : "backward" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu666o6---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "eve", 
          "_id" : "persons/eve", 
          "_rev" : "_Uu666pC--_", 
          "name" : "Eve" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu666p----", 
          "name" : "Bob" 
        }, 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu666o6---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "dave", 
          "_id" : "persons/dave", 
          "_rev" : "_Uu666pC---", 
          "name" : "Dave" 
        }, 
        { 
          "_key" : "charlie", 
          "_id" : "persons/charlie", 
          "_rev" : "_Uu666p---_", 
          "name" : "Charlie" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu666p----", 
          "name" : "Bob" 
        }, 
        { 
          "_key" : "eve", 
          "_id" : "persons/eve", 
          "_rev" : "_Uu666pC--_", 
          "name" : "Eve" 
        }, 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu666o6---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "dave", 
          "_id" : "persons/dave", 
          "_rev" : "_Uu666pC---", 
          "name" : "Dave" 
        }, 
        { 
          "_key" : "charlie", 
          "_id" : "persons/charlie", 
          "_rev" : "_Uu666p---_", 
          "name" : "Charlie" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11313", 
              "_id" : "knows/11313", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu666pK---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu666pC--_", 
              "name" : "Eve" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11313", 
              "_id" : "knows/11313", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu666pK---" 
            }, 
            { 
              "_key" : "11316", 
              "_id" : "knows/11316", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pK--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu666pC--_", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666p----", 
              "name" : "Bob" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11313", 
              "_id" : "knows/11313", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu666pK---" 
            }, 
            { 
              "_key" : "11316", 
              "_id" : "knows/11316", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pK--_" 
            }, 
            { 
              "_key" : "11303", 
              "_id" : "knows/11303", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pG---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu666pC--_", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666p----", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11313", 
              "_id" : "knows/11313", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu666pK---" 
            }, 
            { 
              "_key" : "11316", 
              "_id" : "knows/11316", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pK--_" 
            }, 
            { 
              "_key" : "11310", 
              "_id" : "knows/11310", 
              "_from" : "persons/bob", 
              "_to" : "persons/dave", 
              "_rev" : "_Uu666pG--A" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu666pC--_", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666p----", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "dave", 
              "_id" : "persons/dave", 
              "_rev" : "_Uu666pC---", 
              "name" : "Dave" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11313", 
              "_id" : "knows/11313", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu666pK---" 
            }, 
            { 
              "_key" : "11316", 
              "_id" : "knows/11316", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pK--_" 
            }, 
            { 
              "_key" : "11307", 
              "_id" : "knows/11307", 
              "_from" : "persons/bob", 
              "_to" : "persons/charlie", 
              "_rev" : "_Uu666pG--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu666pC--_", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666p----", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "charlie", 
              "_id" : "persons/charlie", 
              "_rev" : "_Uu666p---_", 
              "name" : "Charlie" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11303", 
              "_id" : "knows/11303", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pG---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666p----", 
              "name" : "Bob" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11303", 
              "_id" : "knows/11303", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pG---" 
            }, 
            { 
              "_key" : "11316", 
              "_id" : "knows/11316", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pK--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666p----", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu666pC--_", 
              "name" : "Eve" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11303", 
              "_id" : "knows/11303", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pG---" 
            }, 
            { 
              "_key" : "11316", 
              "_id" : "knows/11316", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pK--_" 
            }, 
            { 
              "_key" : "11313", 
              "_id" : "knows/11313", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu666pK---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666p----", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu666pC--_", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11303", 
              "_id" : "knows/11303", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pG---" 
            }, 
            { 
              "_key" : "11310", 
              "_id" : "knows/11310", 
              "_from" : "persons/bob", 
              "_to" : "persons/dave", 
              "_rev" : "_Uu666pG--A" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666p----", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "dave", 
              "_id" : "persons/dave", 
              "_rev" : "_Uu666pC---", 
              "name" : "Dave" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11303", 
              "_id" : "knows/11303", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu666pG---" 
            }, 
            { 
              "_key" : "11307", 
              "_id" : "knows/11307", 
              "_from" : "persons/bob", 
              "_to" : "persons/charlie", 
              "_rev" : "_Uu666pG--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu666o6---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu666p----", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "charlie", 
              "_id" : "persons/charlie", 
              "_rev" : "_Uu666p---_", 
              "name" : "Charlie" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

Edges should only be included once globally, but nodes are included every time they are visited

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "uniqueness" : { 
    "vertices" : "none", 
    "edges" : "global" 
  } 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

{ 
  "result" : { 
    "visited" : { 
      "vertices" : [ 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu667Ji---", 
          "name" : "Alice" 
        }, 
        { 
          "_key" : "bob", 
          "_id" : "persons/bob", 
          "_rev" : "_Uu667Ji--_", 
          "name" : "Bob" 
        }, 
        { 
          "_key" : "charlie", 
          "_id" : "persons/charlie", 
          "_rev" : "_Uu667Jm---", 
          "name" : "Charlie" 
        }, 
        { 
          "_key" : "dave", 
          "_id" : "persons/dave", 
          "_rev" : "_Uu667Jm--_", 
          "name" : "Dave" 
        }, 
        { 
          "_key" : "eve", 
          "_id" : "persons/eve", 
          "_rev" : "_Uu667Jq---", 
          "name" : "Eve" 
        }, 
        { 
          "_key" : "alice", 
          "_id" : "persons/alice", 
          "_rev" : "_Uu667Ji---", 
          "name" : "Alice" 
        } 
      ], 
      "paths" : [ 
        { 
          "edges" : [ ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu667Ji---", 
              "name" : "Alice" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11469", 
              "_id" : "knows/11469", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu667Jq--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu667Ji---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu667Ji--_", 
              "name" : "Bob" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11469", 
              "_id" : "knows/11469", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu667Jq--_" 
            }, 
            { 
              "_key" : "11473", 
              "_id" : "knows/11473", 
              "_from" : "persons/bob", 
              "_to" : "persons/charlie", 
              "_rev" : "_Uu667Ju---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu667Ji---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu667Ji--_", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "charlie", 
              "_id" : "persons/charlie", 
              "_rev" : "_Uu667Jm---", 
              "name" : "Charlie" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11469", 
              "_id" : "knows/11469", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu667Jq--_" 
            }, 
            { 
              "_key" : "11476", 
              "_id" : "knows/11476", 
              "_from" : "persons/bob", 
              "_to" : "persons/dave", 
              "_rev" : "_Uu667Ju--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu667Ji---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu667Ji--_", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "dave", 
              "_id" : "persons/dave", 
              "_rev" : "_Uu667Jm--_", 
              "name" : "Dave" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11469", 
              "_id" : "knows/11469", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu667Jq--_" 
            }, 
            { 
              "_key" : "11482", 
              "_id" : "knows/11482", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu667Jy--_" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu667Ji---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu667Ji--_", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu667Jq---", 
              "name" : "Eve" 
            } 
          ] 
        }, 
        { 
          "edges" : [ 
            { 
              "_key" : "11469", 
              "_id" : "knows/11469", 
              "_from" : "persons/alice", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu667Jq--_" 
            }, 
            { 
              "_key" : "11482", 
              "_id" : "knows/11482", 
              "_from" : "persons/eve", 
              "_to" : "persons/bob", 
              "_rev" : "_Uu667Jy--_" 
            }, 
            { 
              "_key" : "11479", 
              "_id" : "knows/11479", 
              "_from" : "persons/eve", 
              "_to" : "persons/alice", 
              "_rev" : "_Uu667Jy---" 
            } 
          ], 
          "vertices" : [ 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu667Ji---", 
              "name" : "Alice" 
            }, 
            { 
              "_key" : "bob", 
              "_id" : "persons/bob", 
              "_rev" : "_Uu667Ji--_", 
              "name" : "Bob" 
            }, 
            { 
              "_key" : "eve", 
              "_id" : "persons/eve", 
              "_rev" : "_Uu667Jq---", 
              "name" : "Eve" 
            }, 
            { 
              "_key" : "alice", 
              "_id" : "persons/alice", 
              "_rev" : "_Uu667Ji---", 
              "name" : "Alice" 
            } 
          ] 
        } 
      ] 
    } 
  }, 
  "error" : false, 
  "code" : 200 
}

Example:

If the underlying graph is cyclic, maxIterations should be set

The underlying graph has two vertices Alice and Bob. With the directed edges:

  • Alice knows Bob
  • Bob knows Alice
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "uniqueness" : { 
    "vertices" : "none", 
    "edges" : "none" 
  }, 
  "maxIterations" : 5 
}
EOF

HTTP/1.1 500 Internal Server Error
content-type: application/json; charset=utf-8

{ 
  "error" : true, 
  "code" : 500, 
  "errorNum" : 1909, 
  "errorMessage" : "too many iterations - try increasing the value of 'maxIterations'" 
}

Return Codes

  • 200: If the traversal is fully executed HTTP 200 will be returned.
  • 400: If the traversal specification is either missing or malformed, the server will respond with HTTP 400.
  • 404: The server will responded with HTTP 404 if the specified edge collection does not exist, or the specified start vertex cannot be found.
  • 500: The server will responded with HTTP 500 when an error occurs inside the traversal or if a traversal performs more than maxIterations iterations.

Examples

In the following examples the underlying graph will contain five persons Alice, Bob, Charlie, Dave and Eve. We will have the following directed relations:

  • Alice knows Bob
  • Bob knows Charlie
  • Bob knows Dave
  • Eve knows Alice
  • Eve knows Bob The starting vertex will always be Alice. Follow only outbound edges
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Follow only inbound edges

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "inbound" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Follow any direction of edges

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "uniqueness" : { 
    "vertices" : "none", 
    "edges" : "global" 
  } 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Excluding Charlie and Bob

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "filter" : "if (vertex.name === \"Bob\" ||     vertex.name === \"Charlie\") {  return \"exclude\";}return;" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Do not follow edges from Bob

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "filter" : "if (vertex.name === \"Bob\") {return \"prune\";}return;" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Visit only nodes in a depth of at least 2

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "minDepth" : 2 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Visit only nodes in a depth of at most 1

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "maxDepth" : 1 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Using a visitor function to return vertex ids only

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "visitor" : "result.visited.vertices.push(vertex._id);" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Count all visited nodes and return a list of nodes only

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "outbound", 
  "init" : "result.visited = 0; result.myVertices = [ ];", 
  "visitor" : "result.visited++; result.myVertices.push(vertex);" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Expand only inbound edges of Alice and outbound edges of Eve

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "expander" : "var connections = [ ];if (vertex.name === \"Alice\") {config.datasource.getInEdges(vertex).forEach(function (e) {connections.push({ vertex: require(\"internal\").db._document(e._from), edge: e});});}if (vertex.name === \"Eve\") {config.datasource.getOutEdges(vertex).forEach(function (e) {connections.push({vertex: require(\"internal\").db._document(e._to), edge: e});});}return connections;" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Follow the depthfirst strategy

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "strategy" : "depthfirst" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Using postorder ordering

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "order" : "postorder" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Using backward item-ordering:

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "itemOrder" : "backward" 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

Edges should only be included once globally, but nodes are included every time they are visited

shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "uniqueness" : { 
    "vertices" : "none", 
    "edges" : "global" 
  } 
}
EOF

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

show response body

If the underlying graph is cyclic, maxIterations should be set The underlying graph has two vertices Alice and Bob. With the directed edges:

  • Alice knows Bob
  • Bob knows Alice
shell> curl -X POST --data-binary @- --dump - http://localhost:8529/_api/traversal <<EOF
{ 
  "startVertex" : "persons/alice", 
  "graphName" : "knows_graph", 
  "direction" : "any", 
  "uniqueness" : { 
    "vertices" : "none", 
    "edges" : "none" 
  }, 
  "maxIterations" : 5 
}
EOF

HTTP/1.1 500 Internal Server Error
content-type: application/json; charset=utf-8

show response body

All examples were using this graph:

Persons relation Example Graph