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/9
Accept: application/json
Example response
200: OK
Content-Type: application/json
{
"extensions" : {
},
"start" : "http://localhost:7474/db/data/node/20",
"property" : "http://localhost:7474/db/data/relationship/9/properties/{key}",
"self" : "http://localhost:7474/db/data/relationship/9",
"properties" : "http://localhost:7474/db/data/relationship/9/properties",
"type" : "know",
"end" : "http://localhost:7474/db/data/node/19",
"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
Content-Type: application/json
{
"to" : "http://localhost:7474/db/data/node/1",
"type" : "LOVES"
}Example response
201: Created
Content-Type: application/json
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
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
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/2
Accept: application/json
Example response
204: No Content
Example request
GET http://localhost:7474/db/data/relationship/5/properties
Accept: application/json
Example response
200: OK
Content-Type: application/json
{
"since" : "1day",
"cost" : "high"
}Example request
PUT http://localhost:7474/db/data/relationship/10/properties
Accept: application/json
Content-Type: application/json
{
"happy" : false
}Example response
204: No Content
Example request
GET http://localhost:7474/db/data/relationship/6/properties/cost
Accept: application/json
Example response
200: OK
Content-Type: application/json
"high"
Example request
PUT http://localhost:7474/db/data/relationship/4/properties/cost
Accept: application/json
Content-Type: application/json
"deadly"
Example response
204: No Content
Example request
GET http://localhost:7474/db/data/node/261/relationships/all
Accept: application/json
Example response
200: OK
Content-Type: application/json
[ {
"start" : "http://localhost:7474/db/data/node/261",
"data" : {
},
"self" : "http://localhost:7474/db/data/relationship/156",
"property" : "http://localhost:7474/db/data/relationship/156/properties/{key}",
"properties" : "http://localhost:7474/db/data/relationship/156/properties",
"type" : "LIKES",
"extensions" : {
},
"end" : "http://localhost:7474/db/data/node/262"
}, {
"start" : "http://localhost:7474/db/data/node/263",
"data" : {
},
"self" : "http://localhost:7474/db/data/relationship/157",
"property" : "http://localhost:7474/db/data/relationship/157/properties/{key}",
"properties" : "http://localhost:7474/db/data/relationship/157/properties",
"type" : "LIKES",
"extensions" : {
},
"end" : "http://localhost:7474/db/data/node/261"
}, {
"start" : "http://localhost:7474/db/data/node/261",
"data" : {
},
"self" : "http://localhost:7474/db/data/relationship/158",
"property" : "http://localhost:7474/db/data/relationship/158/properties/{key}",
"properties" : "http://localhost:7474/db/data/relationship/158/properties",
"type" : "HATES",
"extensions" : {
},
"end" : "http://localhost:7474/db/data/node/264"
} ]Example request
GET http://localhost:7474/db/data/node/280/relationships/in
Accept: application/json
Example response
200: OK
Content-Type: application/json
[ {
"start" : "http://localhost:7474/db/data/node/282",
"data" : {
},
"self" : "http://localhost:7474/db/data/relationship/168",
"property" : "http://localhost:7474/db/data/relationship/168/properties/{key}",
"properties" : "http://localhost:7474/db/data/relationship/168/properties",
"type" : "LIKES",
"extensions" : {
},
"end" : "http://localhost:7474/db/data/node/280"
} ]Example request
GET http://localhost:7474/db/data/node/305/relationships/out
Accept: application/json
Example response
200: OK
Content-Type: application/json
[ {
"start" : "http://localhost:7474/db/data/node/305",
"data" : {
},
"self" : "http://localhost:7474/db/data/relationship/182",
"property" : "http://localhost:7474/db/data/relationship/182/properties/{key}",
"properties" : "http://localhost:7474/db/data/relationship/182/properties",
"type" : "LIKES",
"extensions" : {
},
"end" : "http://localhost:7474/db/data/node/306"
}, {
"start" : "http://localhost:7474/db/data/node/305",
"data" : {
},
"self" : "http://localhost:7474/db/data/relationship/184",
"property" : "http://localhost:7474/db/data/relationship/184/properties/{key}",
"properties" : "http://localhost:7474/db/data/relationship/184/properties",
"type" : "HATES",
"extensions" : {
},
"end" : "http://localhost:7474/db/data/node/308"
} ]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/236/relationships/all/LIKES&HATES
Accept: application/json
Example response
200: OK
Content-Type: application/json
[ {
"start" : "http://localhost:7474/db/data/node/236",
"data" : {
},
"self" : "http://localhost:7474/db/data/relationship/141",
"property" : "http://localhost:7474/db/data/relationship/141/properties/{key}",
"properties" : "http://localhost:7474/db/data/relationship/141/properties",
"type" : "LIKES",
"extensions" : {
},
"end" : "http://localhost:7474/db/data/node/237"
}, {
"start" : "http://localhost:7474/db/data/node/238",
"data" : {
},
"self" : "http://localhost:7474/db/data/relationship/142",
"property" : "http://localhost:7474/db/data/relationship/142/properties/{key}",
"properties" : "http://localhost:7474/db/data/relationship/142/properties",
"type" : "LIKES",
"extensions" : {
},
"end" : "http://localhost:7474/db/data/node/236"
}, {
"start" : "http://localhost:7474/db/data/node/236",
"data" : {
},
"self" : "http://localhost:7474/db/data/relationship/143",
"property" : "http://localhost:7474/db/data/relationship/143/properties/{key}",
"properties" : "http://localhost:7474/db/data/relationship/143/properties",
"type" : "HATES",
"extensions" : {
},
"end" : "http://localhost:7474/db/data/node/239"
} ]Copyright © 2013 Neo Technology