OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
POST/v1/episodes/{id}/links

Create an episode genealogy link

operation ID: post_v1_episodes_by_id_links

Overview

Create an episode genealogy link. Episodes represent bounded operational events and the genealogy links between related events.

When to use it

  • Use it when an application needs to create an episode genealogy link.
  • Use it when an application tracks an incident, batch, excursion, or other event interval and its relationships.

Quick example

Set the base URL and replace generated identifiers or credentials with values from your installation.

cURL

curl --request POST \
  --url "$ORDINATE_URL/v1/episodes/00000000-0000-4000-8000-000000000001/links" \
  --header "Authorization: Bearer $ORDINATE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "to": "00000000-0000-4000-8000-000000000001",
    "link_type": "string"
  }'

Expected output · 201

Created link identity

Example 201 output

{
  "id": "00000000-0000-4000-8000-000000000001"
}

The cURL request sends the smallest contract-derived body and asks OrdinateDB to create an episode genealogy link. The documented 201 response is created link identity.

How it works

Templates define episode shape, episodes carry event state, and genealogy links connect parent, child, or otherwise related records.

Reference

Required capability
episode-manage
Authorization scope
handler-resolved target

Parameters

NameInRequiredType and constraints
idpathyes
stringformat: uuid

Request body

application/json

attributesany ofoptional

Arbitrary JSON value

any of

option 1

object with arbitrary properties

option 2

array

any items

option 3

string

option 4

number

option 5

integer

option 6

boolean

option 7

null
link_typestringrequired
tostringrequired
format: uuid
unknown fields rejected

Example request body

{
  "to": "00000000-0000-4000-8000-000000000001",
  "link_type": "string"
}

Responses

201Created link identity

application/json

idstringrequired
format: uuid
unknown fields rejected

Example 201 output

{
  "id": "00000000-0000-4000-8000-000000000001"
}
400Invalid link or unregistered link type

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 400 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
401Authentication required

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 401 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
403episode-manage capability is not granted

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 403 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
404Episode or template not found

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 404 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
503Model database is not configured or unavailable

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 503 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

Code examples

These examples are generated from the source contract. Replace the base URL, credentials, identifiers, and minimal generated values for your instance.

JavaScript

const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";

const response = await fetch(`${ordinateUrl}/v1/episodes/00000000-0000-4000-8000-000000000001/links`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "to": "00000000-0000-4000-8000-000000000001",
  "link_type": "string"
})
});

if (!response.ok) {
  throw new Error(`OrdinateDB returned ${response.status}: ${await response.text()}`);
}

const data = await response.json();
console.log(data);

Related topics