Creating relations

This page shows some examples on how to use the dScribe API to create relations.

Upsert relations

post

Create one or more relations

Authorizations

Body

from_node_typestringRequired

from_node_idstringRequired

to_node_typestringRequired

to_node_idstringRequired

relation_typestringRequired

Responses

200

Successful operation

400

One of the values passed to the API is wrong

500

Internal server error

post

HTTPcURLJavaScriptPython

POST /api/relations HTTP/1.1
Host: __tenant__.dscribedata.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 114

[
  {
    "from_node_type": "text",
    "from_node_id": "text",
    "to_node_type": "text",
    "to_node_id": "text",
    "relation_type": "text"
  }
]

No content

You cannot create multiple relations with the same relation type between the same two nodes.

Example: create a relation between two assets

const url = "https://{your_tenant}.dscribedata.com/api/relations";
const authToken = "yholmghj8§hbfg...";

fetch(url, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${authToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    relations: [
      {
        "from_node_type": "ASSET",
        "from_node_id": "id1",
        "to_node_type": "ASSET",
        "to_node_id": "id2",
        "relation_type": "is_related"
      }
    ]
  }),
});

Supported node and relation types