OrdinateDB

Documentation

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

List episode genealogy links

operation ID: get_v1_episodes_by_id_links

Overview

List episode genealogy links. Episodes represent bounded operational events and the genealogy links between related events.

When to use it

  • Use it when an application needs to list episode genealogy links.
  • 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 GET \
  --url "$ORDINATE_URL/v1/episodes/00000000-0000-4000-8000-000000000001/links" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Incoming and outgoing links

Example 200 output

{
  "links": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "from_episode": "00000000-0000-4000-8000-000000000001",
      "to_episode": "00000000-0000-4000-8000-000000000001",
      "link_type": "string",
      "attributes": {},
      "created_at_ns": 0
    }
  ]
}

The cURL request supplies the documented path and query values and asks OrdinateDB to list episode genealogy links. The documented 200 response is incoming and outgoing links.

How it works

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

Reference

Required capability
read
Authorization scope
handler-resolved target

Parameters

NameInRequiredType and constraints
idpathyes
stringformat: uuid

Request body

This operation has no request body.

Responses

200Incoming and outgoing links

application/json

linksarrayrequired

array

attributesany ofrequired

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
created_at_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
directionstringoptional
from_episodestringrequired
format: uuid
idstringrequired
format: uuid
link_typestringrequired
to_episodestringrequired
format: uuid
unknown fields rejected
unknown fields rejected

Example 200 output

{
  "links": [
    {
      "id": "00000000-0000-4000-8000-000000000001",
      "from_episode": "00000000-0000-4000-8000-000000000001",
      "to_episode": "00000000-0000-4000-8000-000000000001",
      "link_type": "string",
      "attributes": {},
      "created_at_ns": 0
    }
  ]
}
400Invalid episode id

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"
}
403read 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: "GET",
  headers: {
    Authorization: `Bearer ${token}`
  }
});

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

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

Related topics