OrdinateDB

Documentation

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

Resolve a calendar-aware navigator context window

operation ID: post_v1_displays_time_navigator_context

Overview

Resolve a calendar-aware navigator context window. 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 a calendar-aware navigator context window.
  • 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/navigator-context" \
  --header "Authorization: Bearer $ORDINATE_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "main_start_ns": "1785067200000000000",
    "main_end_ns": "1785067200000000000",
    "context": "day",
    "timezone": {
      "mode": "automatic"
    }
  }'

Expected output · 200

Main and context bounds in the resolved timezone

Example 200 output

{
  "main_start_ns": "1785067200000000000",
  "main_end_ns": "1785067200000000000",
  "context": "string",
  "start_ns": "1785067200000000000",
  "end_ns": "1785067200000000000",
  "timezone": "string",
  "timezone_source_asset": "00000000-0000-4000-8000-000000000001",
  "timezone_fallback": false
}

The cURL request sends the smallest contract-derived body and asks OrdinateDB to resolve a calendar-aware navigator context window. The documented 200 response is main and context bounds in the resolved 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

contextstringrequired
main_end_nsstringrequired

Exact decimal i64 UTC nanoseconds

pattern: ^-?[0-9]+$
main_start_nsstringrequired

Exact decimal i64 UTC nanoseconds

pattern: ^-?[0-9]+$
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

{
  "main_start_ns": "1785067200000000000",
  "main_end_ns": "1785067200000000000",
  "context": "day",
  "timezone": {
    "mode": "automatic"
  }
}

Responses

200Main and context bounds in the resolved timezone

application/json

contextstringrequired
end_nsstringrequired

Exact decimal i64 UTC nanoseconds

pattern: ^-?[0-9]+$
main_end_nsstringrequired

Exact decimal i64 UTC nanoseconds

pattern: ^-?[0-9]+$
main_start_nsstringrequired

Exact decimal i64 UTC nanoseconds

pattern: ^-?[0-9]+$
start_nsstringrequired

Exact decimal i64 UTC nanoseconds

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

any of

option 1

stringformat: uuid

option 2

null
unknown fields rejected

Example 200 output

{
  "main_start_ns": "1785067200000000000",
  "main_end_ns": "1785067200000000000",
  "context": "string",
  "start_ns": "1785067200000000000",
  "end_ns": "1785067200000000000",
  "timezone": "string",
  "timezone_source_asset": "00000000-0000-4000-8000-000000000001",
  "timezone_fallback": false
}
400Bounds are noncanonical, unordered, or outside the calendar range

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"
}
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/navigator-context`, {
  method: "POST",
  headers: {
    Authorization: `Bearer ${token}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "main_start_ns": "1785067200000000000",
  "main_end_ns": "1785067200000000000",
  "context": "day",
  "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