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

Example request

  • GET http://localhost:7474/db/data/relationship/114
  • 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/279",
  "property" : "http://localhost:7474/db/data/relationship/114/properties/{key}",
  "self" : "http://localhost:7474/db/data/relationship/114",
  "properties" : "http://localhost:7474/db/data/relationship/114/properties",
  "type" : "know",
  "end" : "http://localhost:7474/db/data/node/278",
  "metadata" : {
    "id" : 114,
    "type" : "know"
  },
  "data" : {
  }
}

Create relationship

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

Figure 19.20. Final Graph

Example request

  • POST http://localhost:7474/db/data/node/10/relationships
  • Accept: application/json; charset=UTF-8
  • Content-Type: application/json
{
  "to" : "http://localhost:7474/db/data/node/9",
  "type" : "LOVES"
}

Example response

  • 201: Created
  • Content-Type: application/json; charset=UTF-8
  • Location: http://localhost:7474/db/data/relationship/3
{
  "extensions" : {
  },
  "start" : "http://localhost:7474/db/data/node/10",
  "property" : "http://localhost:7474/db/data/relationship/3/properties/{key}",
  "self" : "http://localhost:7474/db/data/relationship/3",
  "properties" : "http://localhost:7474/db/data/relationship/3/properties",
  "type" : "LOVES",
  "end" : "http://localhost:7474/db/data/node/9",
  "metadata" : {
    "id" : 3,
    "type" : "LOVES"
  },
  "data" : {
  }
}

Create a relationship with properties

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

Figure 19.21. Starting Graph

Figure 19.22. Final Graph

Example request

  • POST http://localhost:7474/db/data/node/20/relationships
  • Accept: application/json; charset=UTF-8
  • Content-Type: application/json
{
  "to" : "http://localhost:7474/db/data/node/19",
  "type" : "LOVES",
  "data" : {
    "foo" : "bar"
  }
}

Example response

  • 201: Created
  • Content-Type: application/json; charset=UTF-8
  • Location: http://localhost:7474/db/data/relationship/10
{
  "extensions" : {
  },
  "start" : "http://localhost:7474/db/data/node/20",
  "property" : "http://localhost:7474/db/data/relationship/10/properties/{key}",
  "self" : "http://localhost:7474/db/data/relationship/10",
  "properties" : "http://localhost:7474/db/data/relationship/10/properties",
  "type" : "LOVES",
  "end" : "http://localhost:7474/db/data/node/19",
  "metadata" : {
    "id" : 10,
    "type" : "LOVES"
  },
  "data" : {
    "foo" : "bar"
  }
}

Delete relationship

Figure 19.23. Starting Graph

Figure 19.24. Final Graph

Example request

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

Example response

  • 204: No Content

Get all properties on a relationship

Figure 19.25. Final Graph

Example request

  • GET http://localhost:7474/db/data/relationship/110/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

Figure 19.27. Final Graph

Example request

  • PUT http://localhost:7474/db/data/relationship/115/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

Example request

  • GET http://localhost:7474/db/data/relationship/111/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

Figure 19.30. Final Graph

Example request

  • PUT http://localhost:7474/db/data/relationship/109/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

Example request

  • GET http://localhost:7474/db/data/node/54/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/54",
  "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/55",
  "metadata" : {
    "id" : 27,
    "type" : "LIKES"
  }
}, {
  "start" : "http://localhost:7474/db/data/node/56",
  "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/54",
  "metadata" : {
    "id" : 28,
    "type" : "LIKES"
  }
}, {
  "start" : "http://localhost:7474/db/data/node/54",
  "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/57",
  "metadata" : {
    "id" : 29,
    "type" : "HATES"
  }
} ]

Get incoming relationships

Figure 19.32. Final Graph

Example request

  • GET http://localhost:7474/db/data/node/73/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/75",
  "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/73",
  "metadata" : {
    "id" : 39,
    "type" : "LIKES"
  }
} ]

Get outgoing relationships

Figure 19.33. Final Graph

Example request

  • GET http://localhost:7474/db/data/node/98/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/98",
  "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/99",
  "metadata" : {
    "id" : 53,
    "type" : "LIKES"
  }
}, {
  "start" : "http://localhost:7474/db/data/node/98",
  "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/101",
  "metadata" : {
    "id" : 55,
    "type" : "HATES"
  }
} ]

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

Example request

  • GET http://localhost:7474/db/data/node/29/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/29",
  "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/30",
  "metadata" : {
    "id" : 12,
    "type" : "LIKES"
  }
}, {
  "start" : "http://localhost:7474/db/data/node/31",
  "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/29",
  "metadata" : {
    "id" : 13,
    "type" : "LIKES"
  }
}, {
  "start" : "http://localhost:7474/db/data/node/29",
  "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/32",
  "metadata" : {
    "id" : 14,
    "type" : "HATES"
  }
} ]

Get relationships on a node without relationships

Figure 19.35. Final Graph

Example request

  • GET http://localhost:7474/db/data/node/87/relationships/all
  • Accept: application/json; charset=UTF-8

Example response

  • 200: OK
  • Content-Type: application/json; charset=UTF-8
[ ]