/v1/model/assets/{uuid}/properties/{key}Clear an asset property override
operation ID: delete_v1_model_assets_by_uuid_properties_by_key
Overview
Clear an asset property override. 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 clear an asset property override.
- 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 DELETE \
--url "$ORDINATE_URL/v1/model/assets/00000000-0000-4000-8000-000000000001/properties/operating-mode" \
--header "Authorization: Bearer $ORDINATE_TOKEN" \
--header "Content-Type: application/json" \
--data '{}'Expected output · 200
Cleared property receipt
Example 200 output
{
"property_id": "00000000-0000-4000-8000-000000000001",
"asset_id": "00000000-0000-4000-8000-000000000001",
"key": "string",
"tx_id": 0,
"cleared_at_ns": 0
}The cURL request identifies the target resource and asks OrdinateDB to clear an asset property override. The documented 200 response is cleared property receipt.
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
| Name | In | Required | Type and constraints |
|---|---|---|---|
uuid | path | yes | stringformat: uuid |
key | path | yes | string |
Request body
application/json
expected_txintegeroptional- format: int64
reasonstringoptional
Example request body
{}Responses
200Cleared property receipt
application/json
asset_idstringrequired- format: uuid
cleared_at_nsintegerrequiredUTC Unix timestamp in nanoseconds
format: int64keystringrequiredproperty_idstringrequired- format: uuid
tx_idintegerrequired- format: int64
Example 200 output
{
"property_id": "00000000-0000-4000-8000-000000000001",
"asset_id": "00000000-0000-4000-8000-000000000001",
"key": "string",
"tx_id": 0,
"cleared_at_ns": 0
}401Authentication required
application/json
ErrorEnvelope
codestringrequiredcorrelation_idstringrequired- format: uuid
detailsobjectoptionalerrorstringrequired
Example 401 output
{
"error": "string",
"code": "account-sealed",
"correlation_id": "00000000-0000-4000-8000-000000000001"
}403Model edit capability is not granted
application/json
ErrorEnvelope
codestringrequiredcorrelation_idstringrequired- format: uuid
detailsobjectoptionalerrorstringrequired
Example 403 output
{
"error": "string",
"code": "account-sealed",
"correlation_id": "00000000-0000-4000-8000-000000000001"
}404Property not found
application/json
ErrorEnvelope
codestringrequiredcorrelation_idstringrequired- format: uuid
detailsobjectoptionalerrorstringrequired
Example 404 output
{
"error": "string",
"code": "account-sealed",
"correlation_id": "00000000-0000-4000-8000-000000000001"
}409Transaction conflict
application/json
ErrorEnvelope
codestringrequiredcorrelation_idstringrequired- format: uuid
detailsobjectoptionalerrorstringrequired
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
codestringrequiredcorrelation_idstringrequired- format: uuid
detailsobjectoptionalerrorstringrequired
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/properties/operating-mode`, {
method: "DELETE",
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
- Wire conventions — Understand the prerequisite concepts and transport behavior for this operation.
- REST endpoint index — Find other operations in Model.