OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
PATCH/v1/model/links/{uuid}

Retire or restore an asset link

operation ID: patch_v1_model_links_by_uuid

Overview

Retire or restore 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 retire or restore 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 PATCH \
  --url "$ORDINATE_URL/v1/model/links/00000000-0000-4000-8000-000000000001" \
  --header "Authorization: Bearer $ORDINATE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "retired": false
  }'

Expected output · 200

Updated link

Example 200 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 retire or restore an asset link. The documented 200 response is updated 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

NameInRequiredType and constraints
uuidpathyes
stringformat: uuid

Request body

application/json

expected_txintegeroptional
format: int64
reasonstringoptional
retiredbooleanrequired
unknown fields rejected

Example request body

{
  "retired": false
}

Responses

200Updated 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 200 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
}
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"
}
404Link not found

application/json

ErrorEnvelope
codestringrequired
correlation_idstringrequired
format: uuid
detailsobjectoptional
errorstringrequired

Example 404 output

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}
409Transaction conflict

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/00000000-0000-4000-8000-000000000001`, {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "retired": false
})
});

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

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

Related topics