Prev |  | Next

## 18.5. 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.5.1. Get Relationship by ID

Figure 18.14. Final Graph

Example request

- `GET` `http://localhost:7474/db/data/relationship/18`
- `Accept:` `application/json`

Example response

- `200:` `OK`
- `Content-Type:` `application/json`

    {
      "extensions" : {
      },
      "start" : "http://localhost:7474/db/data/node/47",
      "property" : "http://localhost:7474/db/data/relationship/18/properties/{key}",
      "self" : "http://localhost:7474/db/data/relationship/18",
      "properties" : "http://localhost:7474/db/data/relationship/18/properties",
      "type" : "know",
      "end" : "http://localhost:7474/db/data/node/46",
      "data" : {
      }
    }

### 18.5.2. Create relationship

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

Figure 18.15. Final Graph

Example request

- `POST` `http://localhost:7474/db/data/node/87/relationships`
- `Accept:` `application/json`
- `Content-Type:` `application/json`

    {
      "to" : "http://localhost:7474/db/data/node/86",
      "type" : "LOVES"
    }

Example response

- `201:` `Created`
- `Content-Type:` `application/json`
- `Location:` `http://localhost:7474/db/data/relationship/95`

    {
      "extensions" : {
      },
      "start" : "http://localhost:7474/db/data/node/87",
      "property" : "http://localhost:7474/db/data/relationship/95/properties/{key}",
      "self" : "http://localhost:7474/db/data/relationship/95",
      "properties" : "http://localhost:7474/db/data/relationship/95/properties",
      "type" : "LOVES",
      "end" : "http://localhost:7474/db/data/node/86",
      "data" : {
      }
    }

### 18.5.3. Create a relationship with properties

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

Figure 18.16. Starting Graph

Figure 18.17. Final Graph

Example request

- `POST` `http://localhost:7474/db/data/node/85/relationships`
- `Accept:` `application/json`
- `Content-Type:` `application/json`

    {
      "to" : "http://localhost:7474/db/data/node/84",
      "type" : "LOVES",
      "data" : {
        "foo" : "bar"
      }
    }

Example response

- `201:` `Created`
- `Content-Type:` `application/json`
- `Location:` `http://localhost:7474/db/data/relationship/93`

    {
      "extensions" : {
      },
      "start" : "http://localhost:7474/db/data/node/85",
      "property" : "http://localhost:7474/db/data/relationship/93/properties/{key}",
      "self" : "http://localhost:7474/db/data/relationship/93",
      "properties" : "http://localhost:7474/db/data/relationship/93/properties",
      "type" : "LOVES",
      "end" : "http://localhost:7474/db/data/node/84",
      "data" : {
        "foo" : "bar"
      }
    }

### 18.5.4. Delete relationship

Figure 18.18. Starting Graph

Figure 18.19. Final Graph

Example request

- `DELETE` `http://localhost:7474/db/data/relationship/24`
- `Accept:` `application/json`

Example response

- `204:` `No Content`

### 18.5.5. Get all properties on a relationship

Figure 18.20. Final Graph

Example request

- `GET` `http://localhost:7474/db/data/relationship/28/properties`
- `Accept:` `application/json`

Example response

- `200:` `OK`
- `Content-Type:` `application/json`

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

### 18.5.6. Set all properties on a relationship

Figure 18.21. Starting Graph

Figure 18.22. Final Graph

Example request

- `PUT` `http://localhost:7474/db/data/relationship/27/properties`
- `Accept:` `application/json`
- `Content-Type:` `application/json`

    {
      "happy" : false
    }

Example response

- `204:` `No Content`

### 18.5.7. Get single property on a relationship

Figure 18.23. Final Graph

Example request

- `GET` `http://localhost:7474/db/data/relationship/25/properties/cost`
- `Accept:` `application/json`

Example response

- `200:` `OK`
- `Content-Type:` `application/json`

    "high"

### 18.5.8. Set single property on a relationship

Figure 18.24. Starting Graph

Figure 18.25. Final Graph

Example request

- `PUT` `http://localhost:7474/db/data/relationship/26/properties/cost`
- `Accept:` `application/json`
- `Content-Type:` `application/json`

    "deadly"

Example response

- `204:` `No Content`

### 18.5.9. Get all relationships

Figure 18.26. Final Graph

Example request

- `GET` `http://localhost:7474/db/data/node/78/relationships/all`
- `Accept:` `application/json`

Example response

- `200:` `OK`
- `Content-Type:` `application/json`

    [ {
      "start" : "http://localhost:7474/db/data/node/78",
      "data" : {
      },
      "self" : "http://localhost:7474/db/data/relationship/35",
      "property" : "http://localhost:7474/db/data/relationship/35/properties/{key}",
      "properties" : "http://localhost:7474/db/data/relationship/35/properties",
      "type" : "LIKES",
      "extensions" : {
      },
      "end" : "http://localhost:7474/db/data/node/79"
    }, {
      "start" : "http://localhost:7474/db/data/node/80",
      "data" : {
      },
      "self" : "http://localhost:7474/db/data/relationship/36",
      "property" : "http://localhost:7474/db/data/relationship/36/properties/{key}",
      "properties" : "http://localhost:7474/db/data/relationship/36/properties",
      "type" : "LIKES",
      "extensions" : {
      },
      "end" : "http://localhost:7474/db/data/node/78"
    }, {
      "start" : "http://localhost:7474/db/data/node/78",
      "data" : {
      },
      "self" : "http://localhost:7474/db/data/relationship/37",
      "property" : "http://localhost:7474/db/data/relationship/37/properties/{key}",
      "properties" : "http://localhost:7474/db/data/relationship/37/properties",
      "type" : "HATES",
      "extensions" : {
      },
      "end" : "http://localhost:7474/db/data/node/81"
    } ]

### 18.5.10. Get incoming relationships

Figure 18.27. Final Graph

Example request

- `GET` `http://localhost:7474/db/data/node/88/relationships/in`
- `Accept:` `application/json`

Example response

- `200:` `OK`
- `Content-Type:` `application/json`

    [ {
      "start" : "http://localhost:7474/db/data/node/90",
      "data" : {
      },
      "self" : "http://localhost:7474/db/data/relationship/42",
      "property" : "http://localhost:7474/db/data/relationship/42/properties/{key}",
      "properties" : "http://localhost:7474/db/data/relationship/42/properties",
      "type" : "LIKES",
      "extensions" : {
      },
      "end" : "http://localhost:7474/db/data/node/88"
    } ]

### 18.5.11. Get outgoing relationships

Figure 18.28. Final Graph

Example request

- `GET` `http://localhost:7474/db/data/node/93/relationships/out`
- `Accept:` `application/json`

Example response

- `200:` `OK`
- `Content-Type:` `application/json`

    [ {
      "start" : "http://localhost:7474/db/data/node/93",
      "data" : {
      },
      "self" : "http://localhost:7474/db/data/relationship/44",
      "property" : "http://localhost:7474/db/data/relationship/44/properties/{key}",
      "properties" : "http://localhost:7474/db/data/relationship/44/properties",
      "type" : "LIKES",
      "extensions" : {
      },
      "end" : "http://localhost:7474/db/data/node/94"
    }, {
      "start" : "http://localhost:7474/db/data/node/93",
      "data" : {
      },
      "self" : "http://localhost:7474/db/data/relationship/46",
      "property" : "http://localhost:7474/db/data/relationship/46/properties/{key}",
      "properties" : "http://localhost:7474/db/data/relationship/46/properties",
      "type" : "HATES",
      "extensions" : {
      },
      "end" : "http://localhost:7474/db/data/node/96"
    } ]

### 18.5.12. Get typed relationships

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

Figure 18.29. Final Graph

Example request

- `GET` `http://localhost:7474/db/data/node/98/relationships/all/LIKES&HATES`
- `Accept:` `application/json`

Example response

- `200:` `OK`
- `Content-Type:` `application/json`

    [ {
      "start" : "http://localhost:7474/db/data/node/98",
      "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" : "LIKES",
      "extensions" : {
      },
      "end" : "http://localhost:7474/db/data/node/99"
    }, {
      "start" : "http://localhost:7474/db/data/node/100",
      "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/98"
    }, {
      "start" : "http://localhost:7474/db/data/node/98",
      "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" : "HATES",
      "extensions" : {
      },
      "end" : "http://localhost:7474/db/data/node/101"
    } ]

### 18.5.13. Get relationships on a node without relationships

Figure 18.30. Final Graph

Example request

- `GET` `http://localhost:7474/db/data/node/117/relationships/all`
- `Accept:` `application/json`

Example response

- `200:` `OK`
- `Content-Type:` `application/json`

    [ ]

Copyright © 2012 Neo Technology

Prev | Up | Next
| Home |