OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
GET/v1/model/attributes/{uuid}/bindings

Read an attribute binding timeline

operation ID: get_v1_model_attributes_by_uuid_bindings

Overview

Read an attribute binding timeline. 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 an attribute binding timeline.
  • 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/attributes/00000000-0000-4000-8000-000000000001/bindings" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Binding timeline

Example 200 output

{
  "attribute_id": "00000000-0000-4000-8000-000000000001",
  "segments": [
    {
      "binding_id": "00000000-0000-4000-8000-000000000001",
      "series_uuid": "00000000-0000-4000-8000-000000000001",
      "effective_from_ns": 0,
      "effective_to_ns": 0,
      "tx_id": 0
    }
  ]
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read an attribute binding timeline. The documented 200 response is binding timeline.

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
uuidpathyes
stringformat: uuid
as_of_nsqueryno
integer

UTC Unix timestamp in nanoseconds

format: int64

Request body

This operation has no request body.

Responses

200Binding timeline

application/json

attribute_idstringrequired
format: uuid
segmentsarrayrequired

array

binding_idstringrequired
format: uuid
effective_from_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
effective_to_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
series_uuidstringrequired
format: uuid
tx_idintegerrequired
format: int64
unknown fields rejected
unknown fields rejected

Example 200 output

{
  "attribute_id": "00000000-0000-4000-8000-000000000001",
  "segments": [
    {
      "binding_id": "00000000-0000-4000-8000-000000000001",
      "series_uuid": "00000000-0000-4000-8000-000000000001",
      "effective_from_ns": 0,
      "effective_to_ns": 0,
      "tx_id": 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"
}
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/attributes/00000000-0000-4000-8000-000000000001/bindings`, {
  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);