Retire an attribute instance

Overview

Retire an attribute instance. 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 an attribute instance.
• 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 --request PATCH \
  --url "$ORDINATE_URL/v1/model/attributes/00000000-0000-4000-8000-000000000001" \
  --header "Authorization: Bearer $ORDINATE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{}'

{
  "attribute_id": "00000000-0000-4000-8000-000000000001",
  "asset_id": "00000000-0000-4000-8000-000000000001",
  "attr_def_id": "00000000-0000-4000-8000-000000000001",
  "name": "string",
  "overrides": {},
  "retired": false,
  "tx_id": 0
}

The cURL request sends the smallest contract-derived body and asks OrdinateDB to retire an attribute instance. The documented 200 response is current or retired attribute.

How it works

Reference

Required capability

model-edit

Authorization scope

handler-resolved target

{}

{
  "attribute_id": "00000000-0000-4000-8000-000000000001",
  "asset_id": "00000000-0000-4000-8000-000000000001",
  "attr_def_id": "00000000-0000-4000-8000-000000000001",
  "name": "string",
  "overrides": {},
  "retired": false,
  "tx_id": 0
}

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

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

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

{
  "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.

const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";

const response = await fetch(`${ordinateUrl}/v1/model/attributes/00000000-0000-4000-8000-000000000001`, {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({})
});

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

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