Relationships are a first class citizen in the Neo4j REST API. They can be accessed either stand-alone or through the nodes they are attached to.
The general pattern to get relationships from a node is:
GET http://localhost:7474/db/data/node/123/relationships/{dir}/{-list|&|types}
Where dir
is one of all
, in
, out
and types
is an ampersand-separated list of types.
See the examples below for more information.
Example request
GET
http://localhost:7474/db/data/relationship/211
Accept:
application/json; charset=UTF-8
Example response
200:
OK
Content-Type:
application/json; charset=UTF-8
{ "extensions" : { }, "start" : "http://localhost:7474/db/data/node/331", "property" : "http://localhost:7474/db/data/relationship/211/properties/{key}", "self" : "http://localhost:7474/db/data/relationship/211", "properties" : "http://localhost:7474/db/data/relationship/211/properties", "type" : "know", "end" : "http://localhost:7474/db/data/node/330", "data" : { } }
Upon successful creation of a relationship, the new relationship is returned.
Example request
POST
http://localhost:7474/db/data/node/2/relationships
Accept:
application/json; charset=UTF-8
Content-Type:
application/json
{ "to" : "http://localhost:7474/db/data/node/1", "type" : "LOVES" }
Example response
201:
Created
Content-Type:
application/json; charset=UTF-8
Location:
http://localhost:7474/db/data/relationship/1
{ "extensions" : { }, "start" : "http://localhost:7474/db/data/node/2", "property" : "http://localhost:7474/db/data/relationship/1/properties/{key}", "self" : "http://localhost:7474/db/data/relationship/1", "properties" : "http://localhost:7474/db/data/relationship/1/properties", "type" : "LOVES", "end" : "http://localhost:7474/db/data/node/1", "data" : { } }
Upon successful creation of a relationship, the new relationship is returned.
Example request
POST
http://localhost:7474/db/data/node/12/relationships
Accept:
application/json; charset=UTF-8
Content-Type:
application/json
{ "to" : "http://localhost:7474/db/data/node/11", "type" : "LOVES", "data" : { "foo" : "bar" } }
Example response
201:
Created
Content-Type:
application/json; charset=UTF-8
Location:
http://localhost:7474/db/data/relationship/8
{ "extensions" : { }, "start" : "http://localhost:7474/db/data/node/12", "property" : "http://localhost:7474/db/data/relationship/8/properties/{key}", "self" : "http://localhost:7474/db/data/relationship/8", "properties" : "http://localhost:7474/db/data/relationship/8/properties", "type" : "LOVES", "end" : "http://localhost:7474/db/data/node/11", "data" : { "foo" : "bar" } }
Example request
DELETE
http://localhost:7474/db/data/relationship/204
Accept:
application/json; charset=UTF-8
Example response
204:
No Content
Example request
GET
http://localhost:7474/db/data/relationship/207/properties
Accept:
application/json; charset=UTF-8
Example response
200:
OK
Content-Type:
application/json; charset=UTF-8
{ "since" : "1day", "cost" : "high" }
Example request
PUT
http://localhost:7474/db/data/relationship/212/properties
Accept:
application/json; charset=UTF-8
Content-Type:
application/json
{ "happy" : false }
Example response
204:
No Content
Example request
GET
http://localhost:7474/db/data/relationship/208/properties/cost
Accept:
application/json; charset=UTF-8
Example response
200:
OK
Content-Type:
application/json; charset=UTF-8
"high"
Example request
PUT
http://localhost:7474/db/data/relationship/206/properties/cost
Accept:
application/json; charset=UTF-8
Content-Type:
application/json
"deadly"
Example response
204:
No Content
Example request
GET
http://localhost:7474/db/data/node/55/relationships/all
Accept:
application/json; charset=UTF-8
Example response
200:
OK
Content-Type:
application/json; charset=UTF-8
[ { "start" : "http://localhost:7474/db/data/node/55", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/27", "property" : "http://localhost:7474/db/data/relationship/27/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/27/properties", "type" : "LIKES", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/56" }, { "start" : "http://localhost:7474/db/data/node/57", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/28", "property" : "http://localhost:7474/db/data/relationship/28/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/28/properties", "type" : "LIKES", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/55" }, { "start" : "http://localhost:7474/db/data/node/55", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/29", "property" : "http://localhost:7474/db/data/relationship/29/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/29/properties", "type" : "HATES", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/58" } ]
Example request
GET
http://localhost:7474/db/data/node/74/relationships/in
Accept:
application/json; charset=UTF-8
Example response
200:
OK
Content-Type:
application/json; charset=UTF-8
[ { "start" : "http://localhost:7474/db/data/node/76", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/39", "property" : "http://localhost:7474/db/data/relationship/39/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/39/properties", "type" : "LIKES", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/74" } ]
Example request
GET
http://localhost:7474/db/data/node/99/relationships/out
Accept:
application/json; charset=UTF-8
Example response
200:
OK
Content-Type:
application/json; charset=UTF-8
[ { "start" : "http://localhost:7474/db/data/node/99", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/53", "property" : "http://localhost:7474/db/data/relationship/53/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/53/properties", "type" : "LIKES", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/100" }, { "start" : "http://localhost:7474/db/data/node/99", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/55", "property" : "http://localhost:7474/db/data/relationship/55/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/55/properties", "type" : "HATES", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/102" } ]
Note that the "&
" needs to be encoded like "%26
" for example when
using cURL from the terminal.
Example request
GET
http://localhost:7474/db/data/node/30/relationships/all/LIKES&HATES
Accept:
application/json; charset=UTF-8
Example response
200:
OK
Content-Type:
application/json; charset=UTF-8
[ { "start" : "http://localhost:7474/db/data/node/30", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/12", "property" : "http://localhost:7474/db/data/relationship/12/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/12/properties", "type" : "LIKES", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/31" }, { "start" : "http://localhost:7474/db/data/node/32", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/13", "property" : "http://localhost:7474/db/data/relationship/13/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/13/properties", "type" : "LIKES", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/30" }, { "start" : "http://localhost:7474/db/data/node/30", "data" : { }, "self" : "http://localhost:7474/db/data/relationship/14", "property" : "http://localhost:7474/db/data/relationship/14/properties/{key}", "properties" : "http://localhost:7474/db/data/relationship/14/properties", "type" : "HATES", "extensions" : { }, "end" : "http://localhost:7474/db/data/node/33" } ]
Copyright © 2014 Neo Technology