GET/v1/model/tree

Read the composition tree

operation ID: get_v1_model_tree

Overview

Read the composition tree. 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 the composition tree.
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/tree" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Structural listing; authorization is currently coarse any-Read

Example 200 output

[
  {
    "asset_id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "path": "string",
    "template_id": "00000000-0000-4000-8000-000000000001",
    "retired": false,
    "timezone": "string",
    "effective_timezone": "string",
    "timezone_source_asset": "00000000-0000-4000-8000-000000000001",
    "attributes": [
      {
        "attribute_id": "00000000-0000-4000-8000-000000000001",
        "name": "string",
        "retired": false
      }
    ],
    "children": [
      {
        "asset_id": "00000000-0000-4000-8000-000000000001",
        "name": "string",
        "path": "string",
        "template_id": "00000000-0000-4000-8000-000000000001",
        "retired": false,
        "timezone": "string",
        "effective_timezone": "string",
        "timezone_source_asset": "00000000-0000-4000-8000-000000000001",
        "attributes": [
          {
            "attribute_id": "00000000-0000-4000-8000-000000000001",
            "name": "string",
            "retired": false
          }
        ],
        "children": [
          {
            "asset_id": "00000000-0000-4000-8000-000000000001",
            "name": "string",
            "path": "string",
            "template_id": "00000000-0000-4000-8000-000000000001",
            "retired": false,
            "timezone": "string",
            "effective_timezone": "string",
            "timezone_source_asset": "00000000-0000-4000-8000-000000000001",
            "attributes": [
              {
                "attribute_id": "00000000-0000-4000-8000-000000000001",
                "name": "string",
                "retired": false
              }
            ],
            "children": [
              {
                "asset_id": "00000000-0000-4000-8000-000000000001",
                "name": "string",
                "path": "string",
                "template_id": null,
                "retired": false,
                "timezone": null,
                "effective_timezone": "string",
                "timezone_source_asset": null,
                "attributes": [
                  null
                ],
                "children": [
                  null
                ]
              }
            ]
          }
        ]
      }
    ]
  }
]

The cURL request supplies the documented path and query values and asks OrdinateDB to read the composition tree. The documented 200 response is structural listing; authorization is currently coarse any-Read.

How it works

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

Reference

Wire-format note. Structural listing is authenticated but currently coarse any-Read rather than per-node filtered

Required capability: read
Authorization scope: held anywhere

Parameters

Name	In	Required	Type and constraints
`root`	query	no	`string`
`depth`	query	no	`integer`format: int64
`as_of_ns`	query	no	`integer` UTC Unix timestamp in nanoseconds format: int64
`include_retired`	query	no	`boolean`

Request body

This operation has no request body.

Responses

200Structural listing; authorization is currently coarse any-Read

application/json

array

ModelTreeNode

asset_idstringrequired

format: uuid

attributesarrayrequired

array

attribute_idstringrequired: format: uuid
namestringrequired
retiredbooleanrequired

unknown fields rejected

childrenarrayrequired

array

ModelTreeNode (recursive reference)

effective_timezonestringrequired

namestringrequired

pathstringrequired

retiredbooleanrequired

template_idany ofrequired

any of

option 1

stringformat: uuid

option 2

null

timezoneany ofrequired

any of

option 1

string

option 2

null

timezone_source_assetany ofrequired

any of

option 1

stringformat: uuid

option 2

null

unknown fields rejected

Example 200 output

[
  {
    "asset_id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "path": "string",
    "template_id": "00000000-0000-4000-8000-000000000001",
    "retired": false,
    "timezone": "string",
    "effective_timezone": "string",
    "timezone_source_asset": "00000000-0000-4000-8000-000000000001",
    "attributes": [
      {
        "attribute_id": "00000000-0000-4000-8000-000000000001",
        "name": "string",
        "retired": false
      }
    ],
    "children": [
      {
        "asset_id": "00000000-0000-4000-8000-000000000001",
        "name": "string",
        "path": "string",
        "template_id": "00000000-0000-4000-8000-000000000001",
        "retired": false,
        "timezone": "string",
        "effective_timezone": "string",
        "timezone_source_asset": "00000000-0000-4000-8000-000000000001",
        "attributes": [
          {
            "attribute_id": "00000000-0000-4000-8000-000000000001",
            "name": "string",
            "retired": false
          }
        ],
        "children": [
          {
            "asset_id": "00000000-0000-4000-8000-000000000001",
            "name": "string",
            "path": "string",
            "template_id": "00000000-0000-4000-8000-000000000001",
            "retired": false,
            "timezone": "string",
            "effective_timezone": "string",
            "timezone_source_asset": "00000000-0000-4000-8000-000000000001",
            "attributes": [
              {
                "attribute_id": "00000000-0000-4000-8000-000000000001",
                "name": "string",
                "retired": false
              }
            ],
            "children": [
              {
                "asset_id": "00000000-0000-4000-8000-000000000001",
                "name": "string",
                "path": "string",
                "template_id": null,
                "retired": false,
                "timezone": null,
                "effective_timezone": "string",
                "timezone_source_asset": null,
                "attributes": [
                  null
                ],
                "children": [
                  null
                ]
              }
            ]
          }
        ]
      }
    ]
  }
]

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"
}

404Root 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/tree`, {
  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);

Wire conventions — Understand the prerequisite concepts and transport behavior for this operation.
REST endpoint index — Find other operations in Model.

Read the composition tree

Overview

When to use it

Quick example

How it works

Reference

Parameters

Request body

Responses

Code examples

Related topics