OrdinateDB

Documentation

product Pre-releaseunwritten sections are marked
POST/v1/calc/backfill/{job_id}/cancel

Cancel a calculation backfill

operation ID: post_v1_calc_backfill_by_job_id_cancel

Overview

Cancel a calculation backfill. The calculation API repairs historical derived data and explains how calculated values were produced.

When to use it

  • Use it when an application needs to cancel a calculation backfill.
  • Use it when an engineer is validating derived data, diagnosing a rule, or repairing a historical calculation window.

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/calc/backfill/00000000-0000-4000-8000-000000000001/cancel" \
  --header "Authorization: Bearer $ORDINATE_TOKEN"

Expected output · 200

Cancellation receipt

Example 200 output

{
  "job_id": "00000000-0000-4000-8000-000000000001",
  "state": "string"
}

The cURL request sends the smallest contract-derived body and asks OrdinateDB to cancel a calculation backfill. The documented 200 response is cancellation receipt.

How it works

Backfills are managed jobs, while lineage, status, and trace reads expose the inputs and evaluation state behind calculated series.

Reference

Required capability
calc-author
Authorization scope
handler-resolved target

Parameters

NameInRequiredType and constraints
job_idpathyes
stringformat: uuid

Request body

This operation has no request body.

Responses

200Cancellation receipt

application/json

job_idstringrequired
format: uuid
statestringrequired
unknown fields rejected

Example 200 output

{
  "job_id": "00000000-0000-4000-8000-000000000001",
  "state": "string"
}
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"
}
403calc-author 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"
}
409Backfill cannot be cancelled in its current state

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/calc/backfill/00000000-0000-4000-8000-000000000001/cancel`, {
  method: "POST",
  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);