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 Part III, “Cypher Query Language” or write your own server side plugin executing the interesting traversals with the Java API ( see Section 9.1, “Server Plugins” ) or secure your server, see Section 28.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 22.14.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/405/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/405/relationships/out", "data" : { "name" : "Root" }, "traverse" : "http://localhost:7474/db/data/node/405/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/405/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/405/properties/{key}", "self" : "http://localhost:7474/db/data/node/405", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/405/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/405/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/405/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/405/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/405/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/405/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/405/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/408/relationships/out", "data" : { "name" : "Mattias" }, "traverse" : "http://localhost:7474/db/data/node/408/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/408/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/408/properties/{key}", "self" : "http://localhost:7474/db/data/node/408", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/408/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/408/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/408/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/408/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/408/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/408/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/408/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/407/relationships/out", "data" : { "name" : "Peter" }, "traverse" : "http://localhost:7474/db/data/node/407/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/407/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/407/properties/{key}", "self" : "http://localhost:7474/db/data/node/407", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/407/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/407/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/407/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/407/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/407/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/407/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/407/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/406/relationships/out", "data" : { "name" : "Tobias" }, "traverse" : "http://localhost:7474/db/data/node/406/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/406/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/406/properties/{key}", "self" : "http://localhost:7474/db/data/node/406", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/406/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/406/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/406/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/406/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/406/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/406/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/406/relationships/in/{-list|&|types}" } ]
Example request
POST
http://localhost:7474/db/data/node/399/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/399", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/223", "property" : "http://localhost:7474/db/data/relationship/223/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/223/properties", "type" : "know", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/398" }, { "start" : "http://localhost:7474/db/data/node/399", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/224", "property" : "http://localhost:7474/db/data/relationship/224/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/224/properties", "type" : "own", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/397" } ]
Example request
POST
http://localhost:7474/db/data/node/389/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/389", "nodes" : [ "http://localhost:7474/db/data/node/389" ], "length" : 0, "relationships" : [ ], "end" : "http://localhost:7474/db/data/node/389" }, { "start" : "http://localhost:7474/db/data/node/389", "nodes" : [ "http://localhost:7474/db/data/node/389", "http://localhost:7474/db/data/node/388" ], "length" : 1, "relationships" : [ "http://localhost:7474/db/data/relationship/215" ], "end" : "http://localhost:7474/db/data/node/388" }, { "start" : "http://localhost:7474/db/data/node/389", "nodes" : [ "http://localhost:7474/db/data/node/389", "http://localhost:7474/db/data/node/387" ], "length" : 1, "relationships" : [ "http://localhost:7474/db/data/relationship/216" ], "end" : "http://localhost:7474/db/data/node/387" } ]
Here, all nodes at a traversal depth below 3 are returned.
Example request
POST
http://localhost:7474/db/data/node/393/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/393/relationships/out", "data" : { "name" : "Root" }, "traverse" : "http://localhost:7474/db/data/node/393/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/393/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/393/properties/{key}", "self" : "http://localhost:7474/db/data/node/393", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/393/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/393/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/393/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/393/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/393/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/393/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/393/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/396/relationships/out", "data" : { "name" : "Mattias" }, "traverse" : "http://localhost:7474/db/data/node/396/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/396/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/396/properties/{key}", "self" : "http://localhost:7474/db/data/node/396", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/396/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/396/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/396/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/396/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/396/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/396/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/396/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/391/relationships/out", "data" : { "name" : "Johan" }, "traverse" : "http://localhost:7474/db/data/node/391/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/391/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/391/properties/{key}", "self" : "http://localhost:7474/db/data/node/391", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/391/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/391/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/391/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/391/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/391/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/391/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/391/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/392/relationships/out", "data" : { "name" : "Emil" }, "traverse" : "http://localhost:7474/db/data/node/392/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/392/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/392/properties/{key}", "self" : "http://localhost:7474/db/data/node/392", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/392/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/392/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/392/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/392/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/392/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/392/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/392/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/232/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/232/paged/traverse/node/4cf31f633e624b1ba8d9fe5aa06156c5
[ { "outgoing_relationships" : "http://localhost:7474/db/data/node/233/relationships/out", "data" : { "name" : "1" }, "traverse" : "http://localhost:7474/db/data/node/233/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/233/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/233/properties/{key}", "self" : "http://localhost:7474/db/data/node/233", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/233/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/233/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/233/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/233/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/233/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/233/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/233/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/242/relationships/out", "data" : { "name" : "10" }, "traverse" : "http://localhost:7474/db/data/node/242/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/242/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/242/properties/{key}", "self" : "http://localhost:7474/db/data/node/242", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/242/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/242/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/242/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/242/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/242/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/242/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/242/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/243/relationships/out", "data" : { "name" : "11" }, "traverse" : "http://localhost:7474/db/data/node/243/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/243/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/243/properties/{key}", "self" : "http://localhost:7474/db/data/node/243", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/243/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/243/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/243/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/243/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/243/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/243/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/243/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/244/relationships/out", "data" : { "name" : "12" }, "traverse" : "http://localhost:7474/db/data/node/244/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/244/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/244/properties/{key}", "self" : "http://localhost:7474/db/data/node/244", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/244/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/244/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/244/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/244/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/244/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/244/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/244/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/245/relationships/out", "data" : { "name" : "13" }, "traverse" : "http://localhost:7474/db/data/node/245/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/245/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/245/properties/{key}", "self" : "http://localhost:7474/db/data/node/245", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/245/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/245/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/245/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/245/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/245/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/245/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/245/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/246/relationships/out", "data" : { "name" : "14" }, "traverse" : "http://localhost:7474/db/data/node/246/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/246/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/246/properties/{key}", "self" : "http://localhost:7474/db/data/node/246", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/246/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/246/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/246/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/246/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/246/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/246/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/246/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/247/relationships/out", "data" : { "name" : "15" }, "traverse" : "http://localhost:7474/db/data/node/247/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/247/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/247/properties/{key}", "self" : "http://localhost:7474/db/data/node/247", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/247/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/247/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/247/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/247/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/247/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/247/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/247/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/248/relationships/out", "data" : { "name" : "16" }, "traverse" : "http://localhost:7474/db/data/node/248/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/248/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/248/properties/{key}", "self" : "http://localhost:7474/db/data/node/248", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/248/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/248/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/248/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/248/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/248/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/248/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/248/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/249/relationships/out", "data" : { "name" : "17" }, "traverse" : "http://localhost:7474/db/data/node/249/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/249/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/249/properties/{key}", "self" : "http://localhost:7474/db/data/node/249", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/249/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/249/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/249/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/249/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/249/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/249/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/249/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/250/relationships/out", "data" : { "name" : "18" }, "traverse" : "http://localhost:7474/db/data/node/250/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/250/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/250/properties/{key}", "self" : "http://localhost:7474/db/data/node/250", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/250/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/250/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/250/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/250/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/250/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/250/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/250/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/251/relationships/out", "data" : { "name" : "19" }, "traverse" : "http://localhost:7474/db/data/node/251/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/251/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/251/properties/{key}", "self" : "http://localhost:7474/db/data/node/251", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/251/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/251/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/251/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/251/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/251/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/251/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/251/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/253/relationships/out", "data" : { "name" : "21" }, "traverse" : "http://localhost:7474/db/data/node/253/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/253/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/253/properties/{key}", "self" : "http://localhost:7474/db/data/node/253", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/253/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/253/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/253/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/253/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/253/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/253/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/253/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/263/relationships/out", "data" : { "name" : "31" }, "traverse" : "http://localhost:7474/db/data/node/263/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/263/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/263/properties/{key}", "self" : "http://localhost:7474/db/data/node/263", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/263/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/263/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/263/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/263/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/263/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/263/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/263/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/265/paged/traverse/node/c004850467694ad085b4b29a46bac748
Accept:
application/json
Example response
200:
OK
Content-Type:
application/json
[ { "outgoing_relationships" : "http://localhost:7474/db/data/node/596/relationships/out", "data" : { "name" : "331" }, "traverse" : "http://localhost:7474/db/data/node/596/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/596/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/596/properties/{key}", "self" : "http://localhost:7474/db/data/node/596", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/596/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/596/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/596/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/596/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/596/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/596/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/596/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/606/relationships/out", "data" : { "name" : "341" }, "traverse" : "http://localhost:7474/db/data/node/606/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/606/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/606/properties/{key}", "self" : "http://localhost:7474/db/data/node/606", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/606/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/606/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/606/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/606/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/606/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/606/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/606/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/616/relationships/out", "data" : { "name" : "351" }, "traverse" : "http://localhost:7474/db/data/node/616/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/616/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/616/properties/{key}", "self" : "http://localhost:7474/db/data/node/616", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/616/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/616/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/616/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/616/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/616/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/616/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/616/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/626/relationships/out", "data" : { "name" : "361" }, "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/636/relationships/out", "data" : { "name" : "371" }, "traverse" : "http://localhost:7474/db/data/node/636/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/636/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/636/properties/{key}", "self" : "http://localhost:7474/db/data/node/636", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/636/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/636/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/636/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/636/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/636/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/636/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/636/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/646/relationships/out", "data" : { "name" : "381" }, "traverse" : "http://localhost:7474/db/data/node/646/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/646/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/646/properties/{key}", "self" : "http://localhost:7474/db/data/node/646", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/646/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/646/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/646/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/646/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/646/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/646/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/646/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/656/relationships/out", "data" : { "name" : "391" }, "traverse" : "http://localhost:7474/db/data/node/656/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/656/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/656/properties/{key}", "self" : "http://localhost:7474/db/data/node/656", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/656/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/656/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/656/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/656/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/656/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/656/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/656/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/666/relationships/out", "data" : { "name" : "401" }, "traverse" : "http://localhost:7474/db/data/node/666/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/666/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/666/properties/{key}", "self" : "http://localhost:7474/db/data/node/666", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/666/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/666/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/666/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/666/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/666/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/666/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/666/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/675/relationships/out", "data" : { "name" : "410" }, "traverse" : "http://localhost:7474/db/data/node/675/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/675/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/675/properties/{key}", "self" : "http://localhost:7474/db/data/node/675", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/675/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/675/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/675/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/675/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/675/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/675/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/675/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/676/relationships/out", "data" : { "name" : "411" }, "traverse" : "http://localhost:7474/db/data/node/676/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/676/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/676/properties/{key}", "self" : "http://localhost:7474/db/data/node/676", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/676/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/676/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/676/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/676/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/676/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/676/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/676/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/677/relationships/out", "data" : { "name" : "412" }, "traverse" : "http://localhost:7474/db/data/node/677/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/677/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/677/properties/{key}", "self" : "http://localhost:7474/db/data/node/677", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/677/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/677/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/677/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/677/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/677/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/677/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/677/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/678/relationships/out", "data" : { "name" : "413" }, "traverse" : "http://localhost:7474/db/data/node/678/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/678/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/678/properties/{key}", "self" : "http://localhost:7474/db/data/node/678", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/678/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/678/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/678/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/678/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/678/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/678/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/678/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/679/relationships/out", "data" : { "name" : "414" }, "traverse" : "http://localhost:7474/db/data/node/679/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/679/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/679/properties/{key}", "self" : "http://localhost:7474/db/data/node/679", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/679/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/679/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/679/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/679/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/679/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/679/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/679/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/680/relationships/out", "data" : { "name" : "415" }, "traverse" : "http://localhost:7474/db/data/node/680/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/680/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/680/properties/{key}", "self" : "http://localhost:7474/db/data/node/680", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/680/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/680/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/680/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/680/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/680/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/680/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/680/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/681/relationships/out", "data" : { "name" : "416" }, "traverse" : "http://localhost:7474/db/data/node/681/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/681/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/681/properties/{key}", "self" : "http://localhost:7474/db/data/node/681", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/681/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/681/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/681/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/681/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/681/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/681/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/681/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/682/relationships/out", "data" : { "name" : "417" }, "traverse" : "http://localhost:7474/db/data/node/682/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/682/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/682/properties/{key}", "self" : "http://localhost:7474/db/data/node/682", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/682/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/682/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/682/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/682/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/682/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/682/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/682/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/683/relationships/out", "data" : { "name" : "418" }, "traverse" : "http://localhost:7474/db/data/node/683/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/683/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/683/properties/{key}", "self" : "http://localhost:7474/db/data/node/683", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/683/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/683/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/683/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/683/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/683/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/683/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/683/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/684/relationships/out", "data" : { "name" : "419" }, "traverse" : "http://localhost:7474/db/data/node/684/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/684/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/684/properties/{key}", "self" : "http://localhost:7474/db/data/node/684", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/684/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/684/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/684/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/684/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/684/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/684/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/684/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/686/relationships/out", "data" : { "name" : "421" }, "traverse" : "http://localhost:7474/db/data/node/686/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/686/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/686/properties/{key}", "self" : "http://localhost:7474/db/data/node/686", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/686/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/686/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/686/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/686/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/686/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/686/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/686/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/696/relationships/out", "data" : { "name" : "431" }, "traverse" : "http://localhost:7474/db/data/node/696/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/696/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/696/properties/{key}", "self" : "http://localhost:7474/db/data/node/696", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/696/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/696/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/696/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/696/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/696/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/696/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/696/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/706/relationships/out", "data" : { "name" : "441" }, "traverse" : "http://localhost:7474/db/data/node/706/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/706/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/706/properties/{key}", "self" : "http://localhost:7474/db/data/node/706", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/706/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/706/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/706/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/706/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/706/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/706/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/706/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/34/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/34/paged/traverse/node/7ee92277d4e44aa9844ef6090fc940b9
[ { "outgoing_relationships" : "http://localhost:7474/db/data/node/35/relationships/out", "data" : { "name" : "1" }, "traverse" : "http://localhost:7474/db/data/node/35/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/35/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/35/properties/{key}", "self" : "http://localhost:7474/db/data/node/35", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/35/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/35/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/35/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/35/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/35/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/35/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/35/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/709/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/709/paged/traverse/node/47e5b22f511b47adbb2cc03b3b51f187
[ { "outgoing_relationships" : "http://localhost:7474/db/data/node/710/relationships/out", "data" : { "name" : "1" }, "traverse" : "http://localhost:7474/db/data/node/710/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/710/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/710/properties/{key}", "self" : "http://localhost:7474/db/data/node/710", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/710/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/710/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/710/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/710/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/710/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/710/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/710/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/719/relationships/out", "data" : { "name" : "10" }, "traverse" : "http://localhost:7474/db/data/node/719/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/719/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/719/properties/{key}", "self" : "http://localhost:7474/db/data/node/719", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/719/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/719/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/719/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/719/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/719/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/719/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/719/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/720/relationships/out", "data" : { "name" : "11" }, "traverse" : "http://localhost:7474/db/data/node/720/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/720/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/720/properties/{key}", "self" : "http://localhost:7474/db/data/node/720", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/720/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/720/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/720/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/720/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/720/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/720/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/720/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/721/relationships/out", "data" : { "name" : "12" }, "traverse" : "http://localhost:7474/db/data/node/721/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/721/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/721/properties/{key}", "self" : "http://localhost:7474/db/data/node/721", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/721/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/721/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/721/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/721/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/721/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/721/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/721/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/722/relationships/out", "data" : { "name" : "13" }, "traverse" : "http://localhost:7474/db/data/node/722/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/722/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/722/properties/{key}", "self" : "http://localhost:7474/db/data/node/722", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/722/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/722/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/722/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/722/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/722/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/722/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/722/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/723/relationships/out", "data" : { "name" : "14" }, "traverse" : "http://localhost:7474/db/data/node/723/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/723/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/723/properties/{key}", "self" : "http://localhost:7474/db/data/node/723", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/723/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/723/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/723/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/723/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/723/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/723/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/723/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/724/relationships/out", "data" : { "name" : "15" }, "traverse" : "http://localhost:7474/db/data/node/724/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/724/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/724/properties/{key}", "self" : "http://localhost:7474/db/data/node/724", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/724/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/724/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/724/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/724/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/724/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/724/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/724/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/725/relationships/out", "data" : { "name" : "16" }, "traverse" : "http://localhost:7474/db/data/node/725/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/725/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/725/properties/{key}", "self" : "http://localhost:7474/db/data/node/725", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/725/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/725/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/725/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/725/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/725/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/725/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/725/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/726/relationships/out", "data" : { "name" : "17" }, "traverse" : "http://localhost:7474/db/data/node/726/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/726/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/726/properties/{key}", "self" : "http://localhost:7474/db/data/node/726", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/726/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/726/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/726/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/726/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/726/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/726/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/726/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/727/relationships/out", "data" : { "name" : "18" }, "traverse" : "http://localhost:7474/db/data/node/727/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/727/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/727/properties/{key}", "self" : "http://localhost:7474/db/data/node/727", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/727/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/727/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/727/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/727/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/727/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/727/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/727/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/728/relationships/out", "data" : { "name" : "19" }, "traverse" : "http://localhost:7474/db/data/node/728/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/728/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/728/properties/{key}", "self" : "http://localhost:7474/db/data/node/728", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/728/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/728/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/728/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/728/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/728/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/728/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/728/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/730/relationships/out", "data" : { "name" : "21" }, "traverse" : "http://localhost:7474/db/data/node/730/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/730/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/730/properties/{key}", "self" : "http://localhost:7474/db/data/node/730", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/730/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/730/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/730/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/730/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/730/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/730/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/730/relationships/in/{-list|&|types}" }, { "outgoing_relationships" : "http://localhost:7474/db/data/node/740/relationships/out", "data" : { "name" : "31" }, "traverse" : "http://localhost:7474/db/data/node/740/traverse/{returnType}", "all_typed_relationships" : "http://localhost:7474/db/data/node/740/relationships/all/{-list|&|types}", "property" : "http://localhost:7474/db/data/node/740/properties/{key}", "self" : "http://localhost:7474/db/data/node/740", "outgoing_typed_relationships" : "http://localhost:7474/db/data/node/740/relationships/out/{-list|&|types}", "properties" : "http://localhost:7474/db/data/node/740/properties", "incoming_relationships" : "http://localhost:7474/db/data/node/740/relationships/in", "extensions" : { }, "create_relationship" : "http://localhost:7474/db/data/node/740/relationships", "paged_traverse" : "http://localhost:7474/db/data/node/740/paged/traverse/{returnType}{?pageSize,leaseTime}", "all_relationships" : "http://localhost:7474/db/data/node/740/relationships/all", "incoming_typed_relationships" : "http://localhost:7474/db/data/node/740/relationships/in/{-list|&|types}" } ]
Copyright © 2013 Neo Technology