Read calculation instance health

Overview

Read calculation instance health. 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 instance health.
• 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/rules/00000000-0000-4000-8000-000000000001/status" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

{
  "rule_id": "00000000-0000-4000-8000-000000000001",
  "instances": [
    {
      "asset_id": "00000000-0000-4000-8000-000000000001",
      "output_series": "00000000-0000-4000-8000-000000000001",
      "state": "string",
      "frontier_ns": 0,
      "last_eval_ns": 0,
      "consecutive_failures": 0,
      "provisional_windows": [
        {
          "start_ns": 0,
          "end_ns": 0
        }
      ]
    }
  ]
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read calculation instance health. The documented 200 response is per-instance runtime status.

How it works

Reference

Required capability

read

Authorization scope

handler-resolved target

{
  "rule_id": "00000000-0000-4000-8000-000000000001",
  "instances": [
    {
      "asset_id": "00000000-0000-4000-8000-000000000001",
      "output_series": "00000000-0000-4000-8000-000000000001",
      "state": "string",
      "frontier_ns": 0,
      "last_eval_ns": 0,
      "consecutive_failures": 0,
      "provisional_windows": [
        {
          "start_ns": 0,
          "end_ns": 0
        }
      ]
    }
  ]
}

{
  "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/rules/00000000-0000-4000-8000-000000000001/status`, {
  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);