22.6. Relationships

Prev		Next

22.6.1. Get Relationship by ID
22.6.2. Create relationship
22.6.3. Create a relationship with properties
22.6.4. Delete relationship
22.6.5. Get all properties on a relationship
22.6.6. Set all properties on a relationship
22.6.7. Get single property on a relationship
22.6.8. Set single property on a relationship
22.6.9. Get all relationships
22.6.10. Get incoming relationships
22.6.11. Get outgoing relationships
22.6.12. Get typed relationships
22.6.13. Get relationships on a node without 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.

22.6.1. Get Relationship by ID

Figure 22.15. Final Graph

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" : {
  }
}

22.6.2. Create relationship

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

Figure 22.16. Final Graph

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" : {
  }
}

22.6.3. Create a relationship with properties

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

Figure 22.17. Starting Graph

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

Figure 22.18. Final Graph

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"
  }
}

22.6.4. Delete relationship

Figure 22.19. Starting Graph

Figure 22.20. Final Graph

Example request

DELETE http://localhost:7474/db/data/relationship/2
Accept: application/json

Example response

204: No Content

22.6.5. Get all properties on a relationship

Figure 22.21. Final Graph

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"
}

22.6.6. Set all properties on a relationship

Figure 22.22. Starting Graph

Figure 22.23. Final Graph

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

22.6.7. Get single property on a relationship

Figure 22.24. Final Graph

Example request

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

Example response

200: OK
Content-Type: application/json

"high"

22.6.8. Set single property on a relationship

Figure 22.25. Starting Graph

Figure 22.26. Final Graph

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

22.6.9. Get all relationships

Figure 22.27. Final Graph

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"
} ]

22.6.10. Get incoming relationships

Figure 22.28. Final Graph

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"
} ]

22.6.11. Get outgoing relationships

Figure 22.29. Final Graph

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"
} ]

22.6.12. Get typed relationships

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

Figure 22.30. Final Graph

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"
} ]

22.6.13. Get relationships on a node without relationships

Figure 22.31. Final Graph

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

Example request

GET http://localhost:7474/db/data/node/294/relationships/all
Accept: application/json

Example response

200: OK
Content-Type: application/json

[ ]