OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
GET/v1/model/registries/{kind}/entries/{id}

Read a governed registry entry

operation ID: get_v1_model_registries_by_kind_entries_by_id

Overview

Read a governed registry entry. 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 governed registry entry.
  • 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/registries/quality-codes/entries/00000000-0000-4000-8000-000000000001" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Registry entry

Example 200 output

{
  "id": "00000000-0000-4000-8000-000000000001",
  "name": "string"
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read a governed registry entry. The documented 200 response is registry entry.

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

NameInRequiredType and constraints
kindpathyes
string

values: enum-concepts · enum-sets · quantity-kinds · units · link-types · annotation-tags · episode-roles

idpathyes
stringformat: uuid
as_of_nsqueryno
integer

UTC Unix timestamp in nanoseconds

format: int64

Request body

This operation has no request body.

Responses

200Registry entry

application/json

canonical_unit_idstringoptional
format: uuid
encodingany ofoptional

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
idstringrequired
format: uuid
integrates_toany ofoptional

any of

option 1

stringformat: uuid

option 2

null
kind_idstringoptional
format: uuid
membersany ofoptional

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
rationalestringoptional
symbolstringoptional
systembooleanoptional
to_canonical_factornumberoptional
format: double
to_canonical_offsetnumberoptional
format: double
tx_idintegeroptional
format: int64
valid_from_nsintegeroptional

UTC Unix timestamp in nanoseconds

format: int64
valid_to_nsany ofoptional

any of

option 1

integer

UTC Unix timestamp in nanoseconds

format: int64

option 2

null

Example 200 output

{
  "id": "00000000-0000-4000-8000-000000000001",
  "name": "string"
}
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"
}
404Kind or entry not found

No response body.

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/registries/quality-codes/entries/00000000-0000-4000-8000-000000000001`, {
  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