OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
GET/v1/model/calc/rules/{id}

Read a calculation rule

operation ID: get_v1_model_calc_rules_by_id

Overview

Read 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 read 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

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

Expected output · 200

Calculation rule

Example 200 output

{
  "name": "string",
  "scope": {
    "template_id": "00000000-0000-4000-8000-000000000001",
    "output_attr_def_id": "00000000-0000-4000-8000-000000000001"
  },
  "tier": "expression",
  "trigger": {
    "kind": "event"
  },
  "unit_check": "strict",
  "provisional": "block",
  "rule_id": "00000000-0000-4000-8000-000000000001",
  "version": 0,
  "retired": false,
  "tx_id": 0,
  "valid_from_ns": 0
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read a calculation rule. The documented 200 response is calculation rule.

How it works

Assets form the composition hierarchy, attributes describe values on those assets, and time-bounded bindings connect attributes to stored series.

Reference

Required capability
read
Authorization scope
handler-resolved target

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

200Calculation rule

application/json

declared_inferredbooleanoptional
expressionany ofoptional

any of

option 1

string

option 2

null
namestringrequired
provisionalstringrequired
reasonstringoptional
retiredbooleanrequired
rule_idstringrequired
format: uuid
scopeone ofrequired

one of

option 1

output_attr_def_idstringrequired
format: uuid
template_idstringrequired
format: uuid
unknown fields rejected

option 2

asset_idstringrequired
format: uuid
output_attribute_idstringrequired
format: uuid
unknown fields rejected
tierstringrequired
triggerone ofrequired

one of

option 1

debounce_msany ofoptional

any of

option 1

integerformat: int64

option 2

null
kindstringrequired
unknown fields rejected

option 2

alignany ofrequired

Arbitrary JSON value

any of

option 1

object with arbitrary properties

option 2

array

any items

option 3

string

option 4

number

option 5

integer

option 6

boolean

option 7

null
interval_nsintegerrequired
format: int64
kindstringrequired
unknown fields rejected

option 3

edgestringrequired
exprstringrequired
kindstringrequired
unknown fields rejected
tx_idintegerrequired
format: int64
unit_checkstringrequired
valid_from_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
versionintegerrequired
format: int64
whenany ofoptional

any of

option 1

string

option 2

null
unknown fields rejected

Example 200 output

{
  "name": "string",
  "scope": {
    "template_id": "00000000-0000-4000-8000-000000000001",
    "output_attr_def_id": "00000000-0000-4000-8000-000000000001"
  },
  "tier": "expression",
  "trigger": {
    "kind": "event"
  },
  "unit_check": "strict",
  "provisional": "block",
  "rule_id": "00000000-0000-4000-8000-000000000001",
  "version": 0,
  "retired": false,
  "tx_id": 0,
  "valid_from_ns": 0
}
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"
}
404Rule 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/model/calc/rules/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