Home/Integration & Developer/Record search

Trusted Records · Integration & Developer

Record search

Query authorized metadata/full text. Cursors are opaque; proposed pageSize range is 1–100.

Service Playground — task-based experience OpenAPI and Swagger Reference

Request schema from OpenAPI

Field	Type	Required	Constraints	Technical definition
`query`	string	Yes	`{"minLength": 1}`	Synthetic search expression; production query grammar is unverified.
`pageSize`	integer	Yes	`{"minimum": 1, "maximum": 100}`	Requested page size, at most 100 in this proposal.
`cursor`	['string', 'null']	No	`{}`	Opaque pagination cursor or null for the first page.

Read the operation and next actions

Swagger · search

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

POST /v1/records/search · scope records:read. Tenant/project and correlation contexts are required. POST/PATCH use Idempotency-Key; examples/schemas below are proposed contracts.

States and outputs

REQUEST → AUTHORIZED QUERY → FILTERED RESULT. Every viewer/download rechecks permission.

Exceptions and controls

Invalid query/pageSize returns 422; mismatched context/permissions return 403; errors must not disclose out-of-scope records.

HTTP example — proposed contract

Request

POST https://records.example.invalid/v1/records/search 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
Idempotency-Key: synthetic-key-001
Content-Type: application/json

{
  "query": "synthetic",
  "pageSize": 10,
  "cursor": null
}

Response · 200

{
  "items": [
    {
      "recordId": "synthetic-record-001",
      "title": "Synthetic record"
    }
  ],
  "nextCursor": null
}

Required fields and shared controls

Item	Proposed rule
scope	records:read
required	query, pageSize
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