OrdinateDB

Documentation

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

Rename, move, retire, or unretire an asset

operation ID: patch_v1_model_assets_by_uuid

Overview

Rename, move, retire, or unretire an asset. 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 rename, move, retire, or unretire an asset.
  • 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/assets/00000000-0000-4000-8000-000000000001" \
  --header "Authorization: Bearer $ORDINATE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{}'

Expected output · 200

Updated asset projection

Example 200 output

{
  "asset_id": "00000000-0000-4000-8000-000000000001",
  "parent_id": "00000000-0000-4000-8000-000000000001",
  "name": "string",
  "template_id": "00000000-0000-4000-8000-000000000001",
  "retired": false,
  "tx_id": 0,
  "path": "string",
  "timezone": "string",
  "effective_timezone": "string",
  "timezone_source_asset": "00000000-0000-4000-8000-000000000001"
}

The cURL request sends the smallest contract-derived body and asks OrdinateDB to rename, move, retire, or unretire an asset. The documented 200 response is updated asset projection.

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
moveany ofoptional

any of

option 1

stringformat: uuid

option 2

null
reasonstringoptional
renamestringoptional
retirebooleanoptional
unretirebooleanoptional
unknown fields rejected

Example request body

{}

Responses

200Updated asset projection

application/json

asset_idstringrequired
format: uuid
effective_timezonestringrequired
namestringrequired
parent_idany ofrequired

any of

option 1

stringformat: uuid

option 2

null
pathany ofrequired

any of

option 1

string

option 2

null
retiredbooleanrequired
template_idany ofrequired

any of

option 1

stringformat: uuid

option 2

null
timezoneany ofrequired

any of

option 1

string

option 2

null
timezone_source_assetany ofrequired

any of

option 1

stringformat: uuid

option 2

null
tx_idintegerrequired
format: int64
unknown fields rejected

Example 200 output

{
  "asset_id": "00000000-0000-4000-8000-000000000001",
  "parent_id": "00000000-0000-4000-8000-000000000001",
  "name": "string",
  "template_id": "00000000-0000-4000-8000-000000000001",
  "retired": false,
  "tx_id": 0,
  "path": "string",
  "timezone": "string",
  "effective_timezone": "string",
  "timezone_source_asset": "00000000-0000-4000-8000-000000000001"
}
400Invalid patch

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"
}
404Asset 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"
}
409Name or transaction 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/assets/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);

Related topics