Warning | |
---|---|
The Traversal REST Endpoint executes arbitrary Groovy code under the hood as part of the evaluators definitions. In hosted and open environments, this can constitute a security risk. In these case, consider using declarative approaches like Chapter 15, Cypher Query Language or write your own server side plugin executing the interesting traversals with the Java API ( see Section 10.1, “Server Plugins” ) or secure your server, see Section 24.1, “Securing access to the Neo4j Server”. |
Traversals are performed from a start node. The traversal is controlled by the URI and the body sent with the request.
The kind of objects in the response is determined by traverse/{returnType} in the URL.
returnType
can have one of these values:
node
relationship
path
: contains full representations of start and end node, the rest are URIs.
fullpath
: contains full representations of all nodes and relationships.
To decide how the graph should be traversed you can use these parameters in the request body:
Decides in which order to visit nodes. Possible values:
breadth_first
: see Breadth-first search.
depth_first
: see Depth-first search
Decides which relationship types and directions should be followed. The direction can be one of:
all
in
out
Decides how uniqueness should be calculated. For details on different uniqueness values see the Java API on Uniqueness. Possible values:
node_global
none
relationship_global
node_path
relationship_path
built-in
none
prune evaluator.
Decides whether the current position should be included in the result. You can provide your own code for this (see Section 18.13.1, “Traversal using a return filter”), or use one of the built-in filters:
all
all_but_start_node
prune_evaluator
is specified instead of a max_depth
, no max depth limit is set.
The position
object in the body of the return_filter
and prune_evaluator
is a
Path
object representing the path from the start node to the current traversal position.
Out of the box, the REST API supports JavaScript code in filters and evaluators. The script body will be executed in a Java context which has access to the full Neo4j Java API. See the examples for the exact syntax of the request.
In this example, the none
prune evaluator is used and a return filter
is supplied in order to return all names containing "t".
The result is to be returned as nodes and the max depth is
set to 3.
Example request
POST
http://localhost:7474/db/data/node/13/traverse/node
Accept:
application/json
Content-Type:
application/json
{ "order" : "breadth_first", "return_filter" : { "body" : "position.endNode().getProperty('name').toLowerCase().contains('t')", "language" : "javascript" }, "prune_evaluator" : { "body" : "position.length() > 10", "language" : "javascript" }, "uniqueness" : "node_global", "relationships" : [ { "direction" : "all", "type" : "knows" }, { "direction" : "all", "type" : "loves" } ], "max_depth" : 3 }
Example response
200:
OK
Content-Type:
application/json
[ { "outgoing_relationships" : "http://localhost:7474/db/data/node/13/relationships/out", "data" : { "name" : "Root" }, "traverse" : "http://localhost:7474/db/data/node/13/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/13/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/13/properties/{key}", "self" : "http://localhost:7474/db/data/node/13", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/13/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/13/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/13/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/13/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/13/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/13/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/13/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/16/relationships/out", "data" : { "name" : "Mattias" }, "traverse" : "http://localhost:7474/db/data/node/16/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/16/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/16/properties/{key}", "self" : "http://localhost:7474/db/data/node/16", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/16/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/16/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/16/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/16/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/16/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/16/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/16/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/15/relationships/out", "data" : { "name" : "Peter" }, "traverse" : "http://localhost:7474/db/data/node/15/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/15/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/15/properties/{key}", "self" : "http://localhost:7474/db/data/node/15", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/15/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/15/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/15/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/15/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/15/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/15/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/15/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/14/relationships/out", "data" : { "name" : "Tobias" }, "traverse" : "http://localhost:7474/db/data/node/14/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/14/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/14/properties/{key}", "self" : "http://localhost:7474/db/data/node/14", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/14/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/14/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/14/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/14/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/14/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/14/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/14/relationships/in/{-list|&|types}" } ]
Example request
POST
http://localhost:7474/db/data/node/6/traverse/relationship
Accept:
application/json
Content-Type:
application/json
{ "order" : "breadth_first", "uniqueness" : "none", "return_filter" : { "language" : "builtin", "name" : "all" } }
Example response
200:
OK
Content-Type:
application/json
[ { "start" : "http://localhost:7474/db/data/node/6", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/1", "property" : "http://localhost:7474/db/data/relationship/1/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/1/properties", "type" : "know", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/5" }, { "start" : "http://localhost:7474/db/data/node/6", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/2", "property" : "http://localhost:7474/db/data/relationship/2/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/2/properties", "type" : "own", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/4" } ]
Example request
POST
http://localhost:7474/db/data/node/9/traverse/path
Accept:
application/json
Content-Type:
application/json
{ "order" : "breadth_first", "uniqueness" : "none", "return_filter" : { "language" : "builtin", "name" : "all" } }
Example response
200:
OK
Content-Type:
application/json
[ { "start" : "http://localhost:7474/db/data/node/9", "nodes" : [ "http://localhost:7474/db/data/node/9" ], "length" : 0, "relationships" : [ ], "end" : "http://localhost:7474/db/data/node/9" }, { "start" : "http://localhost:7474/db/data/node/9", "nodes" : [ "http://localhost:7474/db/data/node/9", "http://localhost:7474/db/data/node/8" ], "length" : 1, "relationships" : [ "http://localhost:7474/db/data/relationship/3" ], "end" : "http://localhost:7474/db/data/node/8" }, { "start" : "http://localhost:7474/db/data/node/9", "nodes" : [ "http://localhost:7474/db/data/node/9", "http://localhost:7474/db/data/node/7" ], "length" : 1, "relationships" : [ "http://localhost:7474/db/data/relationship/4" ], "end" : "http://localhost:7474/db/data/node/7" } ]
Here, all nodes at a traversal depth below 3 are returned.
Example request
POST
http://localhost:7474/db/data/node/20/traverse/node
Accept:
application/json
Content-Type:
application/json
{ "return_filter" : { "body" : "position.length()<3;", "language" : "javascript" }, "prune_evaluator" : { "name" : "none", "language" : "builtin" } }
Example response
200:
OK
Content-Type:
application/json
[ { "outgoing_relationships" : "http://localhost:7474/db/data/node/20/relationships/out", "data" : { "name" : "Root" }, "traverse" : "http://localhost:7474/db/data/node/20/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/20/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/20/properties/{key}", "self" : "http://localhost:7474/db/data/node/20", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/20/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/20/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/20/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/20/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/20/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/20/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/20/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/23/relationships/out", "data" : { "name" : "Mattias" }, "traverse" : "http://localhost:7474/db/data/node/23/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/23/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/23/properties/{key}", "self" : "http://localhost:7474/db/data/node/23", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/23/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/23/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/23/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/23/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/23/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/23/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/23/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/18/relationships/out", "data" : { "name" : "Johan" }, "traverse" : "http://localhost:7474/db/data/node/18/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/18/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/18/properties/{key}", "self" : "http://localhost:7474/db/data/node/18", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/18/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/18/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/18/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/18/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/18/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/18/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/18/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/19/relationships/out", "data" : { "name" : "Emil" }, "traverse" : "http://localhost:7474/db/data/node/19/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/19/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/19/properties/{key}", "self" : "http://localhost:7474/db/data/node/19", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/19/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/19/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/19/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/19/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/19/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/19/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/19/relationships/in/{-list|&|types}" } ]
Paged traversers are created by POST
-ing a
traversal description to the link identified by the paged_traverser
key
in a node representation. When creating a paged traverser, the same
options apply as for a regular traverser, meaning that node
, path
,
or fullpath
, can be targeted.
Example request
POST
http://localhost:7474/db/data/node/67/paged/traverse/node
Accept:
application/json
Content-Type:
application/json
{ "prune_evaluator" : { "language" : "builtin", "name" : "none" }, "return_filter" : { "language" : "javascript", "body" : "position.endNode().getProperty('name').contains('1');" }, "order" : "depth_first", "relationships" : { "type" : "NEXT", "direction" : "out" } }
Example response
201:
Created
Content-Type:
application/json
Location:
http://localhost:7474/db/data/node/67/paged/traverse/node/49197ccdb5c5416298abbfed100daacf
[ { "outgoing_relationships" : "http://localhost:7474/db/data/node/68/relationships/out", "data" : { "name" : "1" }, "traverse" : "http://localhost:7474/db/data/node/68/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/68/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/68/properties/{key}", "self" : "http://localhost:7474/db/data/node/68", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/68/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/68/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/68/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/68/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/68/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/68/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/68/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/77/relationships/out", "data" : { "name" : "10" }, "traverse" : "http://localhost:7474/db/data/node/77/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/77/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/77/properties/{key}", "self" : "http://localhost:7474/db/data/node/77", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/77/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/77/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/77/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/77/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/77/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/77/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/77/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/78/relationships/out", "data" : { "name" : "11" }, "traverse" : "http://localhost:7474/db/data/node/78/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/78/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/78/properties/{key}", "self" : "http://localhost:7474/db/data/node/78", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/78/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/78/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/78/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/78/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/78/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/78/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/78/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/79/relationships/out", "data" : { "name" : "12" }, "traverse" : "http://localhost:7474/db/data/node/79/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/79/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/79/properties/{key}", "self" : "http://localhost:7474/db/data/node/79", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/79/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/79/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/79/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/79/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/79/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/79/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/79/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/80/relationships/out", "data" : { "name" : "13" }, "traverse" : "http://localhost:7474/db/data/node/80/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/80/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/80/properties/{key}", "self" : "http://localhost:7474/db/data/node/80", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/80/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/80/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/80/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/80/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/80/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/80/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/80/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/81/relationships/out", "data" : { "name" : "14" }, "traverse" : "http://localhost:7474/db/data/node/81/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/81/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/81/properties/{key}", "self" : "http://localhost:7474/db/data/node/81", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/81/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/81/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/81/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/81/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/81/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/81/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/81/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/82/relationships/out", "data" : { "name" : "15" }, "traverse" : "http://localhost:7474/db/data/node/82/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/82/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/82/properties/{key}", "self" : "http://localhost:7474/db/data/node/82", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/82/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/82/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/82/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/82/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/82/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/82/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/82/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/83/relationships/out", "data" : { "name" : "16" }, "traverse" : "http://localhost:7474/db/data/node/83/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/83/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/83/properties/{key}", "self" : "http://localhost:7474/db/data/node/83", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/83/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/83/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/83/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/83/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/83/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/83/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/83/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/84/relationships/out", "data" : { "name" : "17" }, "traverse" : "http://localhost:7474/db/data/node/84/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/84/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/84/properties/{key}", "self" : "http://localhost:7474/db/data/node/84", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/84/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/84/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/84/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/84/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/84/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/84/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/84/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/85/relationships/out", "data" : { "name" : "18" }, "traverse" : "http://localhost:7474/db/data/node/85/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/85/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/85/properties/{key}", "self" : "http://localhost:7474/db/data/node/85", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/85/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/85/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/85/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/85/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/85/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/85/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/85/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/86/relationships/out", "data" : { "name" : "19" }, "traverse" : "http://localhost:7474/db/data/node/86/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/86/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/86/properties/{key}", "self" : "http://localhost:7474/db/data/node/86", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/86/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/86/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/86/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/86/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/86/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/86/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/86/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/88/relationships/out", "data" : { "name" : "21" }, "traverse" : "http://localhost:7474/db/data/node/88/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/88/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/88/properties/{key}", "self" : "http://localhost:7474/db/data/node/88", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/88/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/88/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/88/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/88/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/88/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/88/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/88/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/98/relationships/out", "data" : { "name" : "31" }, "traverse" : "http://localhost:7474/db/data/node/98/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/98/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/98/properties/{key}", "self" : "http://localhost:7474/db/data/node/98", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/98/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/98/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/98/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/98/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/98/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/98/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/98/relationships/in/{-list|&|types}" } ]
Paged traversers hold state on the server, and allow clients to page through the results of a traversal. To progress to the next page of traversal results, the client issues a HTTP GET request on the paged traversal URI which causes the traversal to fill the next page (or partially fill it if insufficient results are available).
Note that if a traverser expires through inactivity it will cause a 404
response on the next GET
request. Traversers' leases are renewed on
every successful access for the same amount of time as originally
specified.
When the paged traverser reaches the end of its results, the client can expect a 404 response as the traverser is disposed by the server.
Example request
GET
http://localhost:7474/db/data/node/100/paged/traverse/node/99b692506b2d4cbd9dcbf4d0263853fc
Accept:
application/json
Example response
200:
OK
Content-Type:
application/json
[ { "outgoing_relationships" : "http://localhost:7474/db/data/node/431/relationships/out", "data" : { "name" : "331" }, "traverse" : "http://localhost:7474/db/data/node/431/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/431/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/431/properties/{key}", "self" : "http://localhost:7474/db/data/node/431", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/431/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/431/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/431/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/431/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/431/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/431/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/431/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/441/relationships/out", "data" : { "name" : "341" }, "traverse" : "http://localhost:7474/db/data/node/441/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/441/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/441/properties/{key}", "self" : "http://localhost:7474/db/data/node/441", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/441/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/441/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/441/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/441/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/441/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/441/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/441/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/451/relationships/out", "data" : { "name" : "351" }, "traverse" : "http://localhost:7474/db/data/node/451/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/451/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/451/properties/{key}", "self" : "http://localhost:7474/db/data/node/451", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/451/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/451/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/451/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/451/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/451/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/451/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/451/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/461/relationships/out", "data" : { "name" : "361" }, "traverse" : "http://localhost:7474/db/data/node/461/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/461/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/461/properties/{key}", "self" : "http://localhost:7474/db/data/node/461", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/461/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/461/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/461/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/461/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/461/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/461/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/461/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/471/relationships/out", "data" : { "name" : "371" }, "traverse" : "http://localhost:7474/db/data/node/471/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/471/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/471/properties/{key}", "self" : "http://localhost:7474/db/data/node/471", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/471/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/471/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/471/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/471/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/471/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/471/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/471/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/481/relationships/out", "data" : { "name" : "381" }, "traverse" : "http://localhost:7474/db/data/node/481/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/481/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/481/properties/{key}", "self" : "http://localhost:7474/db/data/node/481", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/481/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/481/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/481/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/481/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/481/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/481/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/481/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/491/relationships/out", "data" : { "name" : "391" }, "traverse" : "http://localhost:7474/db/data/node/491/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/491/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/491/properties/{key}", "self" : "http://localhost:7474/db/data/node/491", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/491/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/491/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/491/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/491/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/491/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/491/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/491/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/501/relationships/out", "data" : { "name" : "401" }, "traverse" : "http://localhost:7474/db/data/node/501/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/501/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/501/properties/{key}", "self" : "http://localhost:7474/db/data/node/501", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/501/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/501/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/501/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/501/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/501/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/501/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/501/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/510/relationships/out", "data" : { "name" : "410" }, "traverse" : "http://localhost:7474/db/data/node/510/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/510/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/510/properties/{key}", "self" : "http://localhost:7474/db/data/node/510", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/510/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/510/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/510/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/510/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/510/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/510/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/510/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/511/relationships/out", "data" : { "name" : "411" }, "traverse" : "http://localhost:7474/db/data/node/511/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/511/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/511/properties/{key}", "self" : "http://localhost:7474/db/data/node/511", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/511/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/511/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/511/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/511/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/511/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/511/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/511/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/512/relationships/out", "data" : { "name" : "412" }, "traverse" : "http://localhost:7474/db/data/node/512/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/512/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/512/properties/{key}", "self" : "http://localhost:7474/db/data/node/512", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/512/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/512/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/512/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/512/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/512/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/512/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/512/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/513/relationships/out", "data" : { "name" : "413" }, "traverse" : "http://localhost:7474/db/data/node/513/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/513/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/513/properties/{key}", "self" : "http://localhost:7474/db/data/node/513", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/513/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/513/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/513/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/513/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/513/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/513/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/513/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/514/relationships/out", "data" : { "name" : "414" }, "traverse" : "http://localhost:7474/db/data/node/514/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/514/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/514/properties/{key}", "self" : "http://localhost:7474/db/data/node/514", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/514/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/514/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/514/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/514/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/514/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/514/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/514/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/515/relationships/out", "data" : { "name" : "415" }, "traverse" : "http://localhost:7474/db/data/node/515/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/515/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/515/properties/{key}", "self" : "http://localhost:7474/db/data/node/515", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/515/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/515/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/515/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/515/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/515/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/515/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/515/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/516/relationships/out", "data" : { "name" : "416" }, "traverse" : "http://localhost:7474/db/data/node/516/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/516/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/516/properties/{key}", "self" : "http://localhost:7474/db/data/node/516", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/516/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/516/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/516/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/516/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/516/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/516/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/516/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/517/relationships/out", "data" : { "name" : "417" }, "traverse" : "http://localhost:7474/db/data/node/517/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/517/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/517/properties/{key}", "self" : "http://localhost:7474/db/data/node/517", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/517/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/517/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/517/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/517/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/517/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/517/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/517/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/518/relationships/out", "data" : { "name" : "418" }, "traverse" : "http://localhost:7474/db/data/node/518/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/518/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/518/properties/{key}", "self" : "http://localhost:7474/db/data/node/518", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/518/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/518/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/518/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/518/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/518/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/518/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/518/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/519/relationships/out", "data" : { "name" : "419" }, "traverse" : "http://localhost:7474/db/data/node/519/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/519/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/519/properties/{key}", "self" : "http://localhost:7474/db/data/node/519", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/519/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/519/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/519/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/519/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/519/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/519/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/519/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/521/relationships/out", "data" : { "name" : "421" }, "traverse" : "http://localhost:7474/db/data/node/521/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/521/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/521/properties/{key}", "self" : "http://localhost:7474/db/data/node/521", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/521/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/521/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/521/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/521/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/521/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/521/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/521/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/531/relationships/out", "data" : { "name" : "431" }, "traverse" : "http://localhost:7474/db/data/node/531/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/531/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/531/properties/{key}", "self" : "http://localhost:7474/db/data/node/531", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/531/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/531/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/531/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/531/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/531/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/531/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/531/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/541/relationships/out", "data" : { "name" : "441" }, "traverse" : "http://localhost:7474/db/data/node/541/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/541/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/541/properties/{key}", "self" : "http://localhost:7474/db/data/node/541", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/541/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/541/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/541/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/541/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/541/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/541/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/541/relationships/in/{-list|&|types}" } ]
The default page size is 50 items, but
depending on the application larger or smaller pages sizes might be
appropriate. This can be set by adding a pageSize
query parameter.
Example request
POST
http://localhost:7474/db/data/node/577/paged/traverse/node?pageSize=1
Accept:
application/json
Content-Type:
application/json
{ "prune_evaluator" : { "language" : "builtin", "name" : "none" }, "return_filter" : { "language" : "javascript", "body" : "position.endNode().getProperty('name').contains('1');" }, "order" : "depth_first", "relationships" : { "type" : "NEXT", "direction" : "out" } }
Example response
201:
Created
Content-Type:
application/json
Location:
http://localhost:7474/db/data/node/577/paged/traverse/node/aab44a961e0f45f4819b60907d3a7e17
[ { "outgoing_relationships" : "http://localhost:7474/db/data/node/578/relationships/out", "data" : { "name" : "1" }, "traverse" : "http://localhost:7474/db/data/node/578/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/578/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/578/properties/{key}", "self" : "http://localhost:7474/db/data/node/578", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/578/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/578/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/578/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/578/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/578/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/578/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/578/relationships/in/{-list|&|types}" } ]
The default timeout for a paged traverser is 60
seconds, but depending on the application larger or smaller timeouts
might be appropriate. This can be set by adding a leaseTime
query
parameter with the number of seconds the paged traverser should last.
Example request
POST
http://localhost:7474/db/data/node/610/paged/traverse/node?leaseTime=10
Accept:
application/json
Content-Type:
application/json
{ "prune_evaluator" : { "language" : "builtin", "name" : "none" }, "return_filter" : { "language" : "javascript", "body" : "position.endNode().getProperty('name').contains('1');" }, "order" : "depth_first", "relationships" : { "type" : "NEXT", "direction" : "out" } }
Example response
201:
Created
Content-Type:
application/json
Location:
http://localhost:7474/db/data/node/610/paged/traverse/node/121860a79154433198fb18f1ece111d2
[ { "outgoing_relationships" : "http://localhost:7474/db/data/node/611/relationships/out", "data" : { "name" : "1" }, "traverse" : "http://localhost:7474/db/data/node/611/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/611/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/611/properties/{key}", "self" : "http://localhost:7474/db/data/node/611", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/611/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/611/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/611/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/611/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/611/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/611/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/611/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/620/relationships/out", "data" : { "name" : "10" }, "traverse" : "http://localhost:7474/db/data/node/620/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/620/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/620/properties/{key}", "self" : "http://localhost:7474/db/data/node/620", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/620/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/620/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/620/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/620/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/620/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/620/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/620/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/621/relationships/out", "data" : { "name" : "11" }, "traverse" : "http://localhost:7474/db/data/node/621/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/621/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/621/properties/{key}", "self" : "http://localhost:7474/db/data/node/621", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/621/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/621/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/621/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/621/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/621/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/621/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/621/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/622/relationships/out", "data" : { "name" : "12" }, "traverse" : "http://localhost:7474/db/data/node/622/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/622/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/622/properties/{key}", "self" : "http://localhost:7474/db/data/node/622", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/622/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/622/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/622/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/622/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/622/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/622/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/622/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/623/relationships/out", "data" : { "name" : "13" }, "traverse" : "http://localhost:7474/db/data/node/623/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/623/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/623/properties/{key}", "self" : "http://localhost:7474/db/data/node/623", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/623/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/623/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/623/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/623/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/623/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/623/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/623/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/624/relationships/out", "data" : { "name" : "14" }, "traverse" : "http://localhost:7474/db/data/node/624/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/624/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/624/properties/{key}", "self" : "http://localhost:7474/db/data/node/624", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/624/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/624/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/624/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/624/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/624/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/624/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/624/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/625/relationships/out", "data" : { "name" : "15" }, "traverse" : "http://localhost:7474/db/data/node/625/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/625/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/625/properties/{key}", "self" : "http://localhost:7474/db/data/node/625", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/625/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/625/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/625/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/625/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/625/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/625/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/625/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/626/relationships/out", "data" : { "name" : "16" }, "traverse" : "http://localhost:7474/db/data/node/626/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/626/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/626/properties/{key}", "self" : "http://localhost:7474/db/data/node/626", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/626/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/626/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/626/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/626/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/626/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/626/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/626/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/627/relationships/out", "data" : { "name" : "17" }, "traverse" : "http://localhost:7474/db/data/node/627/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/627/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/627/properties/{key}", "self" : "http://localhost:7474/db/data/node/627", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/627/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/627/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/627/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/627/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/627/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/627/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/627/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/628/relationships/out", "data" : { "name" : "18" }, "traverse" : "http://localhost:7474/db/data/node/628/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/628/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/628/properties/{key}", "self" : "http://localhost:7474/db/data/node/628", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/628/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/628/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/628/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/628/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/628/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/628/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/628/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/629/relationships/out", "data" : { "name" : "19" }, "traverse" : "http://localhost:7474/db/data/node/629/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/629/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/629/properties/{key}", "self" : "http://localhost:7474/db/data/node/629", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/629/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/629/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/629/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/629/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/629/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/629/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/629/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/631/relationships/out", "data" : { "name" : "21" }, "traverse" : "http://localhost:7474/db/data/node/631/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/631/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/631/properties/{key}", "self" : "http://localhost:7474/db/data/node/631", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/631/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/631/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/631/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/631/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/631/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/631/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/631/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/641/relationships/out", "data" : { "name" : "31" }, "traverse" : "http://localhost:7474/db/data/node/641/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/641/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/641/properties/{key}", "self" : "http://localhost:7474/db/data/node/641", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/641/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/641/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/641/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/641/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/641/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/641/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/641/relationships/in/{-list|&|types}" } ]
Copyright © 2012 Neo Technology