18.3. Relationships

18.3.1. Get Relationship by ID
18.3.2. Create relationship
18.3.3. Create a relationship with properties
18.3.4. Delete relationship
18.3.5. Get all properties on a relationship
18.3.6. Set all properties on a relationship
18.3.7. Get single property on a relationship
18.3.8. Set single property on a relationship
18.3.9. Get all relationships
18.3.10. Get incoming relationships
18.3.11. Get outgoing relationships
18.3.12. Get typed relationships
18.3.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.

18.3.1. Get Relationship by ID

Figure 18.2. Final Graph


Example request

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

Example response

  • 200: OK
  • Content-Type: application/json
{
  "start" : "http://localhost:7474/db/data/node/22",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/6",
  "property" : "http://localhost:7474/db/data/relationship/6/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/6/properties",
  "type" : "know",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/21"
}

18.3.2. Create relationship

Documentation not available

Figure 18.3. Final Graph


Example request

  • POST http://localhost:7474/db/data/node/86/relationships
  • Accept: application/json
  • Content-Type: application/json
{"to" : "http://localhost:7474/db/data/node/85", "type" : "LOVES", "data" : {"foo" : "bar"}}

Example response

  • 201: Created
  • Content-Type: application/json
  • Location: http://localhost:7474/db/data/relationship/29
{
  "start" : "http://localhost:7474/db/data/node/86",
  "data" : {
    "foo" : "bar"
  },
  "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" : "LOVES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/85"
}

18.3.3. Create a relationship with properties

Figure 18.4. Starting Graph


Figure 18.5. Final Graph


Example request

  • POST http://localhost:7474/db/data/node/84/relationships
  • Accept: application/json
  • Content-Type: application/json
{"to" : "http://localhost:7474/db/data/node/83", "type" : "LOVES", "data" : {"foo" : "bar"}}

Example response

  • 201: Created
  • Content-Type: application/json
  • Location: http://localhost:7474/db/data/relationship/27
{
  "start" : "http://localhost:7474/db/data/node/84",
  "data" : {
    "foo" : "bar"
  },
  "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" : "LOVES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/83"
}

18.3.4. Delete relationship

Figure 18.6. Starting Graph


Figure 18.7. Final Graph


Example request

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

Example response

  • 204: No Content

18.3.5. Get all properties on a relationship

Figure 18.8. Final Graph


Example request

  • GET http://localhost:7474/db/data/relationship/15/properties
  • Accept: application/json

Example response

  • 200: OK
  • Content-Type: application/json
{
  "since" : "1day",
  "cost" : "high"
}

18.3.6. Set all properties on a relationship

Figure 18.9. Starting Graph


Figure 18.10. Final Graph


Example request

  • PUT http://localhost:7474/db/data/relationship/14/properties
  • Accept: application/json
  • Content-Type: application/json
{
  "happy" : false
}

Example response

  • 204: No Content

18.3.7. Get single property on a relationship

Figure 18.11. Final Graph


Example request

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

Example response

  • 200: OK
  • Content-Type: application/json
"high"

18.3.8. Set single property on a relationship

Figure 18.12. Starting Graph


Figure 18.13. Final Graph


Example request

  • PUT http://localhost:7474/db/data/relationship/13/properties/cost
  • Accept: application/json
  • Content-Type: application/json
"deadly"

Example response

  • 204: No Content

18.3.9. Get all relationships

Example request

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

Example response

  • 200: OK
  • Content-Type: application/json
[ {
  "start" : "http://localhost:7474/db/data/node/113",
  "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/114"
}, {
  "start" : "http://localhost:7474/db/data/node/115",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/40",
  "property" : "http://localhost:7474/db/data/relationship/40/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/40/properties",
  "type" : "LIKES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/113"
}, {
  "start" : "http://localhost:7474/db/data/node/113",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/41",
  "property" : "http://localhost:7474/db/data/relationship/41/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/41/properties",
  "type" : "HATES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/116"
} ]

18.3.10. Get incoming relationships

Example request

  • GET http://localhost:7474/db/data/node/118/relationships/in
  • Accept: application/json

Example response

  • 200: OK
  • Content-Type: application/json
[ {
  "start" : "http://localhost:7474/db/data/node/120",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/43",
  "property" : "http://localhost:7474/db/data/relationship/43/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/43/properties",
  "type" : "LIKES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/118"
} ]

18.3.11. Get outgoing relationships

Example request

  • GET http://localhost:7474/db/data/node/123/relationships/out
  • Accept: application/json

Example response

  • 200: OK
  • Content-Type: application/json
[ {
  "start" : "http://localhost:7474/db/data/node/123",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/45",
  "property" : "http://localhost:7474/db/data/relationship/45/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/45/properties",
  "type" : "LIKES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/124"
}, {
  "start" : "http://localhost:7474/db/data/node/123",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/47",
  "property" : "http://localhost:7474/db/data/relationship/47/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/47/properties",
  "type" : "HATES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/126"
} ]

18.3.12. Get typed relationships

Note that the "&" needs to be escaped for example when using cURL from the terminal.

Example request

  • GET http://localhost:7474/db/data/node/128/relationships/all/LIKES&HATES
  • Accept: application/json

Example response

  • 200: OK
  • Content-Type: application/json
[ {
  "start" : "http://localhost:7474/db/data/node/128",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/48",
  "property" : "http://localhost:7474/db/data/relationship/48/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/48/properties",
  "type" : "LIKES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/129"
}, {
  "start" : "http://localhost:7474/db/data/node/130",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/49",
  "property" : "http://localhost:7474/db/data/relationship/49/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/49/properties",
  "type" : "LIKES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/128"
}, {
  "start" : "http://localhost:7474/db/data/node/128",
  "data" : {
  },
  "self" : "http://localhost:7474/db/data/relationship/50",
  "property" : "http://localhost:7474/db/data/relationship/50/properties/{key}",
  "properties" : "http://localhost:7474/db/data/relationship/50/properties",
  "type" : "HATES",
  "extensions" : {
  },
  "end" : "http://localhost:7474/db/data/node/131"
} ]

18.3.13. Get relationships on a node without relationships

Example request

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

Example response

  • 200: OK
  • Content-Type: application/json
[ ]