OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
POST/v1/model/links

Create an asset link

operation ID: post_v1_model_links

Overview

Create an asset link. 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 create an asset link.
  • 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 POST \
  --url "$ORDINATE_URL/v1/model/links" \
  --header "Authorization: Bearer $ORDINATE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "from_asset": "00000000-0000-4000-8000-000000000001",
    "to_asset": "00000000-0000-4000-8000-000000000001",
    "link_type_id": "00000000-0000-4000-8000-000000000001"
  }'

Expected output · 201

Created link

Example 201 output

{
  "link_id": "00000000-0000-4000-8000-000000000001",
  "from_asset": "00000000-0000-4000-8000-000000000001",
  "to_asset": "00000000-0000-4000-8000-000000000001",
  "link_type_id": "00000000-0000-4000-8000-000000000001",
  "gating_expression": "string",
  "retired": false,
  "tx_id": 0,
  "valid_from_ns": 0
}

The cURL request sends the smallest contract-derived body and asks OrdinateDB to create an asset link. The documented 201 response is created link.

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
model-edit
Authorization scope
handler-resolved target

Parameters

No parameters.

Request body

application/json

from_assetstringrequired
format: uuid
gating_expressionstringoptional
link_type_idstringrequired
format: uuid
reasonstringoptional
to_assetstringrequired
format: uuid
unknown fields rejected

Example request body

{
  "from_asset": "00000000-0000-4000-8000-000000000001",
  "to_asset": "00000000-0000-4000-8000-000000000001",
  "link_type_id": "00000000-0000-4000-8000-000000000001"
}

Responses

201Created link

application/json

from_assetstringrequired
format: uuid
gating_expressionstringrequired
link_idstringrequired
format: uuid
link_type_idstringrequired
format: uuid
retiredbooleanrequired
to_assetstringrequired
format: uuid
tx_idintegerrequired
format: int64
valid_from_nsintegerrequired

UTC Unix timestamp in nanoseconds

format: int64
unknown fields rejected

Example 201 output

{
  "link_id": "00000000-0000-4000-8000-000000000001",
  "from_asset": "00000000-0000-4000-8000-000000000001",
  "to_asset": "00000000-0000-4000-8000-000000000001",
  "link_type_id": "00000000-0000-4000-8000-000000000001",
  "gating_expression": "string",
  "retired": false,
  "tx_id": 0,
  "valid_from_ns": 0
}
400Invalid or self link

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 400 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
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"
}
403Model edit 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"
}
409Duplicate link

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 409 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/links`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "from_asset": "00000000-0000-4000-8000-000000000001",
  "to_asset": "00000000-0000-4000-8000-000000000001",
  "link_type_id": "00000000-0000-4000-8000-000000000001"
})
});

if (!response.ok) {
  throw new Error(`OrdinateDB returned ${response.status}: ${await response.text()}`);
}

const data = await response.json();
console.log(data);

Related topics