OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
GET/v1/model/staging

List staged unbound series

operation ID: get_v1_model_staging

Overview

List staged unbound series. 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 staged unbound series.
  • 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/staging" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Staging entries

Example 200 output

[
  {
    "series_uuid": "00000000-0000-4000-8000-000000000001",
    "source_uri": "string",
    "value_type": "string",
    "first_seen_ns": 0,
    "last_seen_ns": 0
  }
]

The cURL request supplies the documented path and query values and asks OrdinateDB to list staged unbound series. The documented 200 response is staging entries.

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
staging-root

Parameters

No parameters.

Request body

This operation has no request body.

Responses

200Staging entries

application/json

array

first_seen_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
last_seen_nsany ofrequired

any of

option 1

integer

UTC Unix timestamp in nanoseconds

format: int64

option 2

null
series_uuidstringrequired
format: uuid
source_uristringrequired
value_typeany ofrequired

any of

option 1

string

option 2

null
unknown fields rejected

Example 200 output

[
  {
    "series_uuid": "00000000-0000-4000-8000-000000000001",
    "source_uri": "string",
    "value_type": "string",
    "first_seen_ns": 0,
    "last_seen_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"
}
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/staging`, {
  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