OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
POST/v1/displays/time/resolve

Resolve display time expressions exactly

operation ID: post_v1_displays_time_resolve

Overview

Resolve display time expressions exactly. Display operations store, validate, resolve, export, and navigate visualization documents used by operator interfaces.

When to use it

  • Use it when an application needs to resolve display time expressions exactly.
  • Use it when a user interface needs to organize, save, validate, or resolve an operational display.

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/displays/time/resolve" \
  --header "Authorization: Bearer $ORDINATE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "start": "string",
    "end": "string",
    "timezone": {
      "mode": "automatic"
    }
  }'

Expected output · 200

Resolved exact bounds and display timezone

Example 200 output

{
  "start_expression": "string",
  "end_expression": "string",
  "start_ns": "1785067200000000000",
  "end_ns": "1785067200000000000",
  "start_utc": "string",
  "end_utc": "string",
  "start_local": "string",
  "end_local": "string",
  "timezone": "string",
  "timezone_source_asset": "00000000-0000-4000-8000-000000000001",
  "timezone_fallback": false,
  "live": false
}

The cURL request sends the smallest contract-derived body and asks OrdinateDB to resolve display time expressions exactly. The documented 200 response is resolved exact bounds and display timezone.

How it works

Display documents are versioned independently from their folders, while resolve and time routes prepare a document for a specific asset and viewing window.

Reference

Required capability
read
Authorization scope
handler-resolved target

Parameters

No parameters.

Request body

application/json

endstringrequired
end_disambiguationstringoptional
startstringrequired
start_disambiguationstringoptional
timezoneone ofrequired

one of

option 1

asset_idstringoptional
format: uuid
modestringrequired
unknown fields rejected

option 2

modestringrequired
timezonestringrequired
unknown fields rejected
unknown fields rejected

Example request body

{
  "start": "string",
  "end": "string",
  "timezone": {
    "mode": "automatic"
  }
}

Responses

200Resolved exact bounds and display timezone

application/json

end_expressionstringrequired
end_localstringrequired
end_nsstringrequired

Exact decimal i64 UTC nanoseconds

pattern: ^-?[0-9]+$
end_utcstringrequired
livebooleanrequired
start_expressionstringrequired
start_localstringrequired
start_nsstringrequired

Exact decimal i64 UTC nanoseconds

pattern: ^-?[0-9]+$
start_utcstringrequired
timezonestringrequired
timezone_fallbackbooleanrequired
timezone_source_assetany ofrequired

any of

option 1

stringformat: uuid

option 2

null
unknown fields rejected

Example 200 output

{
  "start_expression": "string",
  "end_expression": "string",
  "start_ns": "1785067200000000000",
  "end_ns": "1785067200000000000",
  "start_utc": "string",
  "end_utc": "string",
  "start_local": "string",
  "end_local": "string",
  "timezone": "string",
  "timezone_source_asset": "00000000-0000-4000-8000-000000000001",
  "timezone_fallback": false,
  "live": false
}
400Invalid timezone, syntax, range, or nonexistent local time

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"
}
403read 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"
}
404Automatic timezone asset 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"
}
409Ambiguous local time requires disambiguation

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/displays/time/resolve`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "start": "string",
  "end": "string",
  "timezone": {
    "mode": "automatic"
  }
})
});

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

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

Related topics