Read the finalisation watermark

Overview

Read the finalisation watermark. Series-storage operations expose registered series, direct stored data, gap and chunk metadata, and lifecycle controls.

When to use it

• Use it when an application needs to read the finalisation watermark.
• Use it when a diagnostic or maintenance tool needs storage-level series data instead of model-resolved attributes.

Quick example

Set the base URL and replace generated identifiers or credentials with values from your installation.

curl --request GET \
  --url "$ORDINATE_URL/v1/series/00000000-0000-4000-8000-000000000001/finalised" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

{
  "finalised_through_ns": 0
}

The cURL request supplies the documented path and query values and asks OrdinateDB to read the finalisation watermark. The documented 200 response is finalisation watermark.

How it works

Reference

Required capability

read

Authorization scope

owning asset of series path parameter `uuid`, or staging-root

{
  "finalised_through_ns": 0
}

{
  "error": "string",
  "code": "account-sealed",
  "correlation_id": "00000000-0000-4000-8000-000000000001"
}

{
  "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/series/00000000-0000-4000-8000-000000000001/finalised`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${token}`
  }
});

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

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