Home/Integration & Developer/Processing jobs and status

Trusted Records · Integration & Developer

Processing jobs and status

Track asynchronous jobs and object-level errors. Tool progress is synthetic.

Service Playground — task-based experience OpenAPI and Swagger Reference

Request schema from OpenAPI

GET has no request body; Swagger documents paths/context.

Read the operation and next actions

Swagger · job

Errors and next actions

A consistent error envelope guides recovery without disclosing sensitive data.

Read details

Reliability, concurrency and recovery

Retry design follows the side effect rather than repeating every request blindly.

Read details

API Explorer — local simulator

Explore requests/responses and failure scenarios using synthetic data; no backend connection.

Read details

Input, scopes and processing

GET /v1/jobs/{jobId} · scope jobs:read. Tenant/project and correlation contexts are required. POST/PATCH use Idempotency-Key; examples/schemas below are proposed contracts.

States and outputs

QUEUED → RUNNING / VALIDATING → SUCCEEDED / FAILED / REVIEW_PENDING. SUCCEEDED describes the job only.

Exceptions and controls

404 for missing jobs within scope; 403 for authorization failures; illustrative 503 for service unavailability.

HTTP example — proposed contract

Request

GET https://records.example.invalid/v1/jobs/{jobId} HTTP/1.1
Authorization: Bearer <example-token>
X-Tenant-Id: synthetic-tenant-001
X-Project-Id: synthetic-project-001
X-Correlation-Id: synthetic-correlation-001

Response · 200

{
  "jobId": "synthetic-job-001",
  "status": "VALIDATING",
  "progress": {
    "processed": 1,
    "total": 2
  },
  "errors": [],
  "correlationId": "synthetic-correlation-001"
}

Required fields and shared controls

Item	Proposed rule
scope	jobs:read
required	No request body
tenant / project	Token and context must match; headers alone are insufficient.
idempotency	POST/PATCH: same key/body returns original result; changed body returns 409; confirm retention window.
error	code, message, requestId, correlationId, retryable, details; no sensitive data.

Continue the workflow

Two journeys, one records lifecycle

Connect paper and born-digital records through persistent identifiers, policies and evidence.

Read details

Integration quickstart

Exercise ingest → job tracking → registration → verification with synthetic data.

Read details

Integrity, provenance and evidence

Each evidence type answers a different question; hashes, timestamps and approvals are not interchangeable.

Read details

Start with a verifiable scope.

Agree record classes, quality criteria, permissions and evidence before scaling.

Plan assessment