Creating relations

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

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"
      }
    ]
  }),
});

PreviousDeleting DSEs NextDeleting relations

Last updated 14 days ago

Upsert relations

Create one or more relations

POSThttps://__tenant__.dscribedata.com/api/relations

Authorization

Body

A list of relations to be created

from_node_type*string

from_node_id*string

to_node_type*string

to_node_id*string

relation_type*string

Response

Successful operation

Request

const response = await fetch('https://__tenant__.dscribedata.com/api/relations', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify([
      {
        "from_node_type": "text",
        "from_node_id": "text",
        "to_node_type": "text",
        "to_node_id": "text",
        "relation_type": "text"
      }
    ]),
});
const data = await response.json();