Read calculation lineage at a series instant

Overview

Read calculation lineage at a series instant. The calculation API repairs historical derived data and explains how calculated values were produced.

When to use it

• Use it when an application needs to read calculation lineage at a series instant.
• Use it when an engineer is validating derived data, diagnosing a rule, or repairing a historical calculation window.

Quick example

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

curl --request GET \
  --url "$ORDINATE_URL/v1/calc/lineage?series=00000000-0000-4000-8000-000000000001&ts_ns=0" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

{
  "rule_id": "00000000-0000-4000-8000-000000000001",
  "rule_version": 0,
  "window": {
    "start_ns": 0,
    "end_ns": 0
  },
  "evaluated_at_ns": 0,
  "inputs": {}
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read calculation lineage at a series instant. The documented 200 response is covering evaluation with latest computed_at_ns.

How it works

Reference

Required capability

read

Authorization scope

held anywhere

{
  "rule_id": "00000000-0000-4000-8000-000000000001",
  "rule_version": 0,
  "window": {
    "start_ns": 0,
    "end_ns": 0
  },
  "evaluated_at_ns": 0,
  "inputs": {}
}

{
  "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/calc/lineage?series=00000000-0000-4000-8000-000000000001&ts_ns=0`, {
  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);