19.8. Relationships

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.

Get Relationship by ID

Figure 19.19. Final Graph

Final-Graph-get-Relationship-by-ID.svg

Example request

  • GET http://localhost:7474/db/data/relationship/9
  • 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/43",
  "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/42",
  "data" : {
  }
}

Create relationship

Upon successful creation of a relationship, the new relationship is returned.

Figure 19.20. Final Graph

Final-Graph-Create-relationship.svg

Example request

  • POST http://localhost:7474/db/data/node/1/relationships
  • Accept: application/json; charset=UTF-8
  • Content-Type: application/json 
{
  "to" : "http://localhost:7474/db/data/node/0",
  "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/1",
  "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/0",
  "data" : {
  }
}

Create a relationship with properties

Upon successful creation of a relationship, the new relationship is returned.

Figure 19.21. Starting Graph

Starting-Graph-Add-relationship-with-properties-before.svg

Figure 19.22. Final Graph

Final-Graph-Create-a-relationship-with-properties.svg

Example request

  • POST http://localhost:7474/db/data/node/11/relationships
  • Accept: application/json; charset=UTF-8
  • Content-Type: application/json 
{
  "to" : "http://localhost:7474/db/data/node/10",
  "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/11",
  "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/10",
  "data" : {
    "foo" : "bar"
  }
}

Delete relationship

Figure 19.23. Starting Graph

Starting-Graph-Delete-relationship1.svg

Figure 19.24. Final Graph

Final-Graph-Delete-relationship.svg

Example request

  • DELETE http://localhost:7474/db/data/relationship/2
  • Accept: application/json; charset=UTF-8

Example response

  • 204: No Content 




Get all properties on a relationship



Figure 19.25. Final Graph


Final-Graph-get-all-properties-on-a-relationship.svg




Example request


  • 

GET  http://localhost:7474/db/data/relationship/5/properties


  • 

Accept: application/json; charset=UTF-8




Example response


  • 

200: OK


  • 

Content-Type: application/json; charset=UTF-8




{
  "since" : "1day",
  "cost" : "high"
}




Set all properties on a relationship



Figure 19.26. Starting Graph


Starting-Graph-Set-relationship-property1.svg




Figure 19.27. Final Graph


Final-Graph-set-all-properties-on-a-relationship.svg




Example request


  • 

PUT  http://localhost:7474/db/data/relationship/10/properties


  • 

Accept: application/json; charset=UTF-8


  • 

Content-Type: application/json




{
  "happy" : false
}


Example response


  • 

204: No Content








Get single property on a relationship



Figure 19.28. Final Graph


Final-Graph-get-single-property-on-a-relationship.svg




Example request


  • 

GET  http://localhost:7474/db/data/relationship/6/properties/cost


  • 

Accept: application/json; charset=UTF-8




Example response


  • 

200: OK


  • 

Content-Type: application/json; charset=UTF-8




"high"




Set single property on a relationship



Figure 19.29. Starting Graph


Starting-Graph-Set-relationship-property1.svg




Figure 19.30. Final Graph


Final-Graph-set-single-property-on-a-relationship.svg




Example request


  • 

PUT  http://localhost:7474/db/data/relationship/4/properties/cost


  • 

Accept: application/json; charset=UTF-8


  • 

Content-Type: application/json




"deadly"


Example response


  • 

204: No Content








Get all relationships



Figure 19.31. Final Graph


Final-Graph-Get-all-relationships.svg




Example request


  • 

GET  http://localhost:7474/db/data/node/326/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/326",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/204",
  "property" : "http://localhost:7474/db/data/relationship/204/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/204/properties",
  "type" : "LIKES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/327"
}, {
  "start" : "http://localhost:7474/db/data/node/328",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/205",
  "property" : "http://localhost:7474/db/data/relationship/205/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/205/properties",
  "type" : "LIKES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/326"
}, {
  "start" : "http://localhost:7474/db/data/node/326",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/206",
  "property" : "http://localhost:7474/db/data/relationship/206/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/206/properties",
  "type" : "HATES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/329"
} ]




Get incoming relationships



Figure 19.32. Final Graph


Final-Graph-Get-incoming-relationships.svg




Example request


  • 

GET  http://localhost:7474/db/data/node/345/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/347",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/216",
  "property" : "http://localhost:7474/db/data/relationship/216/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/216/properties",
  "type" : "LIKES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/345"
} ]




Get outgoing relationships



Figure 19.33. Final Graph


Final-Graph-Get-outgoing-relationships.svg




Example request


  • 

GET  http://localhost:7474/db/data/node/370/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/370",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/230",
  "property" : "http://localhost:7474/db/data/relationship/230/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/230/properties",
  "type" : "LIKES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/371"
}, {
  "start" : "http://localhost:7474/db/data/node/370",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/232",
  "property" : "http://localhost:7474/db/data/relationship/232/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/232/properties",
  "type" : "HATES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/373"
} ]




Get typed relationships



Note that the "&" needs to be encoded like "%26" for example when
using cURL from the terminal.


Figure 19.34. Final Graph


Final-Graph-Get-typed-relationships.svg




Example request


  • 

GET  http://localhost:7474/db/data/node/301/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/301",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/189",
  "property" : "http://localhost:7474/db/data/relationship/189/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/189/properties",
  "type" : "LIKES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/302"
}, {
  "start" : "http://localhost:7474/db/data/node/303",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/190",
  "property" : "http://localhost:7474/db/data/relationship/190/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/190/properties",
  "type" : "LIKES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/301"
}, {
  "start" : "http://localhost:7474/db/data/node/301",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/191",
  "property" : "http://localhost:7474/db/data/relationship/191/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/191/properties",
  "type" : "HATES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/304"
} ]




Get relationships on a node without relationships



Figure 19.35. Final Graph


Final-Graph-Get-relationships-on-a-node-without-relationships.svg




Example request


  • 

GET  http://localhost:7474/db/data/node/359/relationships/all


  • 

Accept: application/json; charset=UTF-8




Example response


  • 

200: OK


  • 

Content-Type: application/json; charset=UTF-8




[ ]