/v1/series/{uuid}/raw-auditRead every stored revision in audit order
operation ID: get_v1_series_by_uuid_raw_audit
Overview
Read every stored revision in audit order. 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 every stored revision in audit order.
- 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
curl --request GET \
--url "$ORDINATE_URL/v1/series/00000000-0000-4000-8000-000000000001/raw-audit?start_ns=0&end_ns=0" \
--header "Authorization: Bearer $ORDINATE_TOKEN"Expected output · 200
Revision order is the audit record
Example 200 output
{
"series": "00000000-0000-4000-8000-000000000001",
"points": [
{
"ts_ns": 0,
"revision": 0,
"arrival_ns": 0,
"value": 0,
"quality": 0
}
]
}The cURL request supplies the documented path and query values and asks OrdinateDB to read every stored revision in audit order. The documented 200 response is revision order is the audit record.
How it works
These routes address a stable series UUID directly. Use resolved-read routes when an application should follow model bindings across time.
Reference
- Required capability
- read
- Authorization scope
- owning asset of series path parameter `uuid`, or staging-root
Parameters
| Name | In | Required | Type and constraints |
|---|---|---|---|
uuid | path | yes | stringformat: uuid |
start_ns | query | yes | integerUTC Unix timestamp in nanoseconds format: int64 |
end_ns | query | yes | integerUTC Unix timestamp in nanoseconds format: int64 |
stat | query | no | stringvalues: count · min · max · first · last · twa · percent_good |
Request body
This operation has no request body.
Responses
200Revision order is the audit record
application/json
pointsarrayrequiredarray
arrival_nsintegerrequiredUTC Unix timestamp in nanoseconds
format: int64qualityintegerrequired- minimum: 0
revisionintegerrequired- minimum: 0
ts_nsintegerrequiredUTC Unix timestamp in nanoseconds
format: int64valueany ofrequiredNative typed value: number, boolean, string, or digital ordinal
any of
option 1
numberoption 2
integerformat: int64option 3
booleanoption 4
stringoption 5
enum_setstringrequiredordinalintegerrequired- format: int64
seriesstringrequired- format: uuid
Example 200 output
{
"series": "00000000-0000-4000-8000-000000000001",
"points": [
{
"ts_ns": 0,
"revision": 0,
"arrival_ns": 0,
"value": 0,
"quality": 0
}
]
}400Invalid UUID or range
application/json
ErrorEnvelope
codestringrequiredcorrelation_idstringrequired- format: uuid
detailsobjectoptionalerrorstringrequired
Example 400 output
{
"error": "string",
"code": "account-sealed",
"correlation_id": "00000000-0000-4000-8000-000000000001"
}text/plain
string401Authentication required
application/json
ErrorEnvelope
codestringrequiredcorrelation_idstringrequired- format: uuid
detailsobjectoptionalerrorstringrequired
Example 401 output
{
"error": "string",
"code": "account-sealed",
"correlation_id": "00000000-0000-4000-8000-000000000001"
}403Read 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"
}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/series/00000000-0000-4000-8000-000000000001/raw-audit?start_ns=0&end_ns=0`, {
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);Related topics
- Wire conventions — Understand the prerequisite concepts and transport behavior for this operation.
- REST endpoint index — Find other operations in Series storage.