OrdinateDB

Documentation

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

Read an episode

operation ID: get_v1_episodes_by_id

Overview

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

When to use it

  • Use it when an application needs to read an episode.
  • 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" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Current episode record

Example 200 output

{
  "id": "00000000-0000-4000-8000-000000000001",
  "template": {
    "id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "version": 0
  },
  "name": "string",
  "state": "open",
  "start_ns": 0,
  "end_ns": 0,
  "parent": "00000000-0000-4000-8000-000000000001",
  "asset_refs": [
    {
      "asset_id": "00000000-0000-4000-8000-000000000001",
      "role": "string"
    }
  ],
  "attributes": {},
  "flags": [
    "string"
  ],
  "origin": "trigger",
  "void": {
    "reason": "string",
    "at_ns": 0,
    "by": "string"
  },
  "created_at_ns": 0,
  "version": 0
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read an episode. The documented 200 response is current episode record.

How it works

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

Reference

Wire-format note. A voided episode still returns 200 with its full record. Provisional captured values are stored and refreshed on the engine tick, not recomputed by this read.
Required capability
read
Authorization scope
handler-resolved target

Parameters

NameInRequiredType and constraints
idpathyes
stringformat: uuid
include_childrenqueryno
boolean
include_linksqueryno
boolean

Request body

This operation has no request body.

Responses

200Current episode record

application/json

asset_refsarrayrequired

array

asset_idstringrequired
format: uuid
rolestringrequired
unknown fields rejected
attributesobjectrequired
childrenarrayoptional

array

stringformat: uuid
created_at_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
end_nsany ofrequired

any of

option 1

integer

UTC Unix timestamp in nanoseconds

format: int64

option 2

null
flagsarrayrequired

array

string
idstringrequired
format: uuid
linksany 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
namestringrequired
originstringrequired
parentany ofrequired

any of

option 1

stringformat: uuid

option 2

null
start_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
statestringrequired
templateobjectrequired
unknown fields rejected
idstringrequired
format: uuid
namestringrequired
versionintegerrequired
format: int64
unknown fields rejected
versionintegerrequired
format: int64
voidany ofrequired

any of

option 1

at_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
bystringrequired
reasonstringrequired
unknown fields rejected

option 2

null
unknown fields rejected

Example 200 output

{
  "id": "00000000-0000-4000-8000-000000000001",
  "template": {
    "id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "version": 0
  },
  "name": "string",
  "state": "open",
  "start_ns": 0,
  "end_ns": 0,
  "parent": "00000000-0000-4000-8000-000000000001",
  "asset_refs": [
    {
      "asset_id": "00000000-0000-4000-8000-000000000001",
      "role": "string"
    }
  ],
  "attributes": {},
  "flags": [
    "string"
  ],
  "origin": "trigger",
  "void": {
    "reason": "string",
    "at_ns": 0,
    "by": "string"
  },
  "created_at_ns": 0,
  "version": 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`, {
  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