Retire a calculation rule

Overview

Retire a calculation rule. The model API describes assets, attributes, bindings, templates, views, registries, and governed changes that give series data its operational meaning.

When to use it

• Use it when an application needs to retire a calculation rule.
• Use it when a modeling tool is building, governing, resolving, or inspecting the asset and attribute hierarchy.

Quick example

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

curl --request POST \
  --url "$ORDINATE_URL/v1/model/calc/rules/00000000-0000-4000-8000-000000000001/retire" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

{
  "rule_id": "00000000-0000-4000-8000-000000000001",
  "retired": false
}

The cURL request sends the smallest contract-derived body and asks OrdinateDB to retire a calculation rule. The documented 200 response is retirement receipt.

How it works

Reference

Required capability

calc-author

Authorization scope

handler-resolved target

{
  "rule_id": "00000000-0000-4000-8000-000000000001",
  "retired": false
}

{
  "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/model/calc/rules/00000000-0000-4000-8000-000000000001/retire`, {
  method: "POST",
  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);