GET/v1/model/views/{uuid}/tree

Read a view tree

operation ID: get_v1_model_views_by_uuid_tree

Overview

Read a view 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 a view 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/views/00000000-0000-4000-8000-000000000001/tree" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

View tree nodes

Example 200 output

[
  {
    "node": {
      "node_id": "00000000-0000-4000-8000-000000000001",
      "view_id": "00000000-0000-4000-8000-000000000001",
      "parent_node": "00000000-0000-4000-8000-000000000001",
      "label": "string",
      "ref_asset": "00000000-0000-4000-8000-000000000001",
      "sort_key": 0
    },
    "display_label": "string",
    "children": [
      {
        "node": {
          "node_id": "00000000-0000-4000-8000-000000000001",
          "view_id": "00000000-0000-4000-8000-000000000001",
          "parent_node": "00000000-0000-4000-8000-000000000001",
          "label": "string",
          "ref_asset": "00000000-0000-4000-8000-000000000001",
          "sort_key": 0
        },
        "display_label": "string",
        "children": [
          {
            "node": {
              "node_id": "00000000-0000-4000-8000-000000000001",
              "view_id": "00000000-0000-4000-8000-000000000001",
              "parent_node": "00000000-0000-4000-8000-000000000001",
              "label": "string",
              "ref_asset": "00000000-0000-4000-8000-000000000001",
              "sort_key": 0
            },
            "display_label": "string",
            "children": [
              {
                "node": {
                  "node_id": null,
                  "view_id": null,
                  "parent_node": null,
                  "label": null,
                  "ref_asset": null,
                  "sort_key": null
                },
                "display_label": "string",
                "children": [
                  null
                ]
              }
            ]
          }
        ]
      }
    ]
  }
]

The cURL request supplies the documented path and query values and asks OrdinateDB to read a view tree. The documented 200 response is view tree nodes.

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: view-node path parameter `uuid`

Parameters

Name	In	Required	Type and constraints
`uuid`	path	yes	`string`format: uuid
`as_of_ns`	query	no	`integer` UTC Unix timestamp in nanoseconds format: int64

Request body

This operation has no request body.

Responses

200View tree nodes

application/json

array

ViewTreeNode

childrenarrayrequired

array

ViewTreeNode (recursive reference)

display_labelstringrequired

nodeobjectrequired

unknown fields rejected

labelany ofrequired: any of
option 1
string
option 2
null
node_idstringrequired: format: uuid
parent_nodeany ofrequired: any of
option 1
stringformat: uuid
option 2
null
ref_assetany ofrequired: any of
option 1
stringformat: uuid
option 2
null
sort_keyintegerrequired: format: int64
view_idstringrequired: format: uuid

unknown fields rejected

Example 200 output

[
  {
    "node": {
      "node_id": "00000000-0000-4000-8000-000000000001",
      "view_id": "00000000-0000-4000-8000-000000000001",
      "parent_node": "00000000-0000-4000-8000-000000000001",
      "label": "string",
      "ref_asset": "00000000-0000-4000-8000-000000000001",
      "sort_key": 0
    },
    "display_label": "string",
    "children": [
      {
        "node": {
          "node_id": "00000000-0000-4000-8000-000000000001",
          "view_id": "00000000-0000-4000-8000-000000000001",
          "parent_node": "00000000-0000-4000-8000-000000000001",
          "label": "string",
          "ref_asset": "00000000-0000-4000-8000-000000000001",
          "sort_key": 0
        },
        "display_label": "string",
        "children": [
          {
            "node": {
              "node_id": "00000000-0000-4000-8000-000000000001",
              "view_id": "00000000-0000-4000-8000-000000000001",
              "parent_node": "00000000-0000-4000-8000-000000000001",
              "label": "string",
              "ref_asset": "00000000-0000-4000-8000-000000000001",
              "sort_key": 0
            },
            "display_label": "string",
            "children": [
              {
                "node": {
                  "node_id": null,
                  "view_id": null,
                  "parent_node": null,
                  "label": null,
                  "ref_asset": null,
                  "sort_key": null
                },
                "display_label": "string",
                "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"
}

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/views/00000000-0000-4000-8000-000000000001/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 a view tree

Overview

When to use it

Quick example

How it works

Reference

Parameters

Request body

Responses

Code examples

Related topics