OrdinateDB

Documentation

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

Create an attribute instance

operation ID: post_v1_model_attributes

Overview

Create 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 create 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

curl --request POST \
  --url "$ORDINATE_URL/v1/model/attributes" \
  --header "Authorization: Bearer $ORDINATE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "asset": "00000000-0000-4000-8000-000000000001",
    "name": "string"
  }'

Expected output · 200

Created attribute

Example 200 output

{
  "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 create an attribute instance. The documented 200 response is created attribute.

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

assetstringrequired
format: uuid
attr_def_idstringoptional
format: uuid
defany 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
overridesany 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
reasonstringoptional
unknown fields rejected

Example request body

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

Responses

200Created attribute

application/json

asset_idstringrequired
format: uuid
attr_def_idany ofrequired

any of

option 1

stringformat: uuid

option 2

null
attribute_idstringrequired
format: uuid
namestringrequired
overridesany ofrequired

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
retiredbooleanrequired
tx_idintegerrequired
format: int64
unknown fields rejected

Example 200 output

{
  "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
}
400Invalid attribute

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 or definition 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"
}
409Attribute name 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/attributes`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "asset": "00000000-0000-4000-8000-000000000001",
  "name": "string"
})
});

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

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

Related topics