GET/v1/model/templates

List templates

operation ID: get_v1_model_templates

Overview

List templates. 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 list templates.
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/templates" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Templates

Example 200 output

[
  {
    "template_id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "permitted_children": [
      "00000000-0000-4000-8000-000000000001"
    ],
    "notes": "string",
    "attributes": [
      [
        "00000000-0000-4000-8000-000000000001",
        {
          "name": "string",
          "quantity_kind_id": "00000000-0000-4000-8000-000000000001",
          "default_unit_id": "00000000-0000-4000-8000-000000000001",
          "continuity_class": "continuous",
          "writer_class": "collector",
          "enum_set_id": "00000000-0000-4000-8000-000000000001",
          "limit_traits": {},
          "lifecycle_policy": {},
          "entry_cadence": {},
          "overridable": [
            "string"
          ]
        }
      ]
    ],
    "tx_id": 0
  }
]

The cURL request supplies the documented path and query values and asks OrdinateDB to list templates. The documented 200 response is templates.

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: held anywhere

Parameters

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

Request body

This operation has no request body.

Responses

200Templates

application/json

array

attributesarrayrequired

array

array · min 2 · max 2

item 1

stringformat: uuid

item 2

continuity_classstringrequired
default_unit_idany ofrequired: any of
option 1
stringformat: uuid
option 2
null
entry_cadenceany ofrequired: any of
option 1
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
option 2
null
enum_set_idany ofrequired: any of
option 1
stringformat: uuid
option 2
null
lifecycle_policyany ofrequired: any of
option 1
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
option 2
null
limit_traitsany 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
namestringrequired
overridablearrayrequired: array
string
quantity_kind_idany ofrequired: any of
option 1
stringformat: uuid
option 2
null
writer_classstringrequired

unknown fields rejected

namestringrequired

notesstringrequired

permitted_childrenarrayrequired

array

stringformat: uuid

template_idstringrequired

format: uuid

tx_idintegerrequired

format: int64

unknown fields rejected

Example 200 output

[
  {
    "template_id": "00000000-0000-4000-8000-000000000001",
    "name": "string",
    "permitted_children": [
      "00000000-0000-4000-8000-000000000001"
    ],
    "notes": "string",
    "attributes": [
      [
        "00000000-0000-4000-8000-000000000001",
        {
          "name": "string",
          "quantity_kind_id": "00000000-0000-4000-8000-000000000001",
          "default_unit_id": "00000000-0000-4000-8000-000000000001",
          "continuity_class": "continuous",
          "writer_class": "collector",
          "enum_set_id": "00000000-0000-4000-8000-000000000001",
          "limit_traits": {},
          "lifecycle_policy": {},
          "entry_cadence": {},
          "overridable": [
            "string"
          ]
        }
      ]
    ],
    "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/templates`, {
  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.

List templates

Overview

When to use it

Quick example

How it works

Reference

Parameters

Request body

Responses

Code examples

Related topics