Create entity {entityType} link

POST/workspaces/{organizationId}/entities/{entityType}/{entityId}/links

Path parameters

organizationIdstringrequired

entityTypestringrequired

entityIdstringrequired

Request body

application/json

toTypestringrequired

min length 1

toIdstringrequired

min length 1

kindstring

default: "relates"

labelstring

Responses

201

Linked

linkobjectrequired

Show properties

idstringrequired

organizationIdstringrequired

fromTypestringrequired

fromIdstringrequired

toTypestringrequired

toIdstringrequired

kindstringrequired

labelstring | nullrequired

createdAtstringrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*entityTypepath*entityIdpath*

Bodyapplication/json

toTypestring*toIdstring*kindstringlabelstring

Request

curl -X POST '/workspaces/string/entities/string/string/links' \
  -H 'Content-Type: application/json' \
  -d '{
  "toType": "string",
  "toId": "string",
  "kind": "relates",
  "label": "string"
}'

const response = await fetch("/workspaces/string/entities/string/string/links", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"toType\": \"string\",\n  \"toId\": \"string\",\n  \"kind\": \"relates\",\n  \"label\": \"string\"\n}"
});

import requests

response = requests.post(
    "/workspaces/string/entities/string/string/links",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"toType\": \"string\",\n  \"toId\": \"string\",\n  \"kind\": \"relates\",\n  \"label\": \"string\"\n}",
)

Response

{
  "link": {
    "id": "string",
    "organizationId": "string",
    "fromType": "string",
    "fromId": "string",
    "toType": "string",
    "toId": "string",
    "kind": "string",
    "label": "string",
    "createdAt": "string"
  }
}