Report model database readiness

Overview

Report model database readiness. 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 report model database readiness.
• 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 --request GET \
  --url "$ORDINATE_URL/v1/model/healthz"

{
  "model": "ok",
  "migrations": 0
}

The cURL request supplies the documented path and query values and asks OrdinateDB to report model database readiness. The documented 200 response is model store is reachable and migrated.

How it works

Reference

Required capability

anonymous

Authorization scope

none

{
  "model": "ok",
  "migrations": 0
}

{
  "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.

const ordinateUrl = "http://localhost:8080";
const token = "<bearer-token>";

const response = await fetch(`${ordinateUrl}/v1/model/healthz`, {
  method: "GET"
});

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

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