OrdinateDB

Documentation

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

Read an episode template

operation ID: get_v1_episodes_templates_by_id

Overview

Read an episode template. 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 template.
  • 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/templates/00000000-0000-4000-8000-000000000001" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Template valid at the requested time

Example 200 output

{
  "name": "string",
  "family": "string",
  "overlap": "allowed",
  "retro_edit_approval": "none",
  "id": "00000000-0000-4000-8000-000000000001",
  "version": 0
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read an episode template. The documented 200 response is template valid at the requested time.

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
held anywhere

Parameters

NameInRequiredType and constraints
idpathyes
stringformat: uuid
as_of_nsqueryno
integer

UTC Unix timestamp in nanoseconds

format: int64

Request body

This operation has no request body.

Responses

200Template valid at the requested time

application/json

attributesarrayoptional

array

captureany ofrequired

any of

option 1

string

option 2

null
classstringrequired
enum_setany ofrequired

any of

option 1

string

option 2

null
namestringrequired
quantity_kindany ofrequired

any of

option 1

string

option 2

null
unitany ofrequired

any of

option 1

string

option 2

null
unknown fields rejected
familystringrequired
idstringrequired
format: uuid
namestringrequired
naming_patternany ofoptional

any of

option 1

string

option 2

null
overlapstringrequired
permitted_childrenarrayoptional

array

string
reasonstringoptional
retro_edit_approvalstringrequired
rolesarrayoptional

array

cardinalitystringrequired
requiredbooleanrequired
rolestringrequired
unknown fields rejected
triggerany ofoptional

any of

option 1

min_duration_msintegerrequired
format: int64
open_whenstringrequired
unknown fields rejected

option 2

null
versionintegerrequired
format: int64
unknown fields rejected

Example 200 output

{
  "name": "string",
  "family": "string",
  "overlap": "allowed",
  "retro_edit_approval": "none",
  "id": "00000000-0000-4000-8000-000000000001",
  "version": 0
}
400Invalid template 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/templates/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