Create an episode

Overview

Create 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 create 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 --request POST \
  --url "$ORDINATE_URL/v1/episodes" \
  --header "Authorization: Bearer $ORDINATE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "template": "00000000-0000-4000-8000-000000000001",
    "start_ns": 0
  }'

{
  "id": "00000000-0000-4000-8000-000000000001",
  "version": 0,
  "name": "string",
  "flags": [
    "string"
  ],
  "origin": "trigger"
}

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

How it works

Reference

Required capability

episode-manage

Authorization scope

handler-resolved target

{
  "template": "00000000-0000-4000-8000-000000000001",
  "start_ns": 0
}

{
  "id": "00000000-0000-4000-8000-000000000001",
  "version": 0,
  "name": "string",
  "flags": [
    "string"
  ],
  "origin": "trigger"
}

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

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

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

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

{
  "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.

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

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

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

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