ENTITY developer reference
Inspect own operation
Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.
This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.
GET /v1/operations/{operation_id}
Operation identifier: getOperation
For classification orders, the class(a) cutoff returns operation_expired/410 even if a subject-free receipt survives; never reconstruct ICOperationResult from that receipt. This pure owned read creates no new business effect or debit. Its failure reports only not_started/unchanged with null operation/status references. Existing underlying financial uncertainty is shown in the successful owned status envelope; unavailable read dependencies use the existing dependency_unavailable retry path. Never report a new reservation/settlement or invent a polling operation for this read. Original-resource disclosure: The caller must have the exact original integration service-principal relation, or the exact operation_id of its own original classification order, with current status permission. No separate named operation kind or human-steward substitute. Returned results independently require their current result/source guards; no foreign key recovery or cross-tenant operation metadata. Resolve authentication and exact same-workspace/environment owned relation before action-specific disclosure. Missing/foreign relation is the same opaque resource_not_found404. Only a proved owned relation may return an action-specific permission_denied403. No role or guessed identifier reveals another creator object; an entirely unauthenticated request remains unauthenticated401. Every current credential/action/profile/source/retention guard still applies. Non-retired suspension: A non-retired organisation security/financial suspension admits only the original authenticated integration service principal status/cancellation corridor below. Credential/session/principal revocation, compromised identity or retired binding has its own stricter denial and is never bypassed. Verify the original workspace/environment and integration service-principal identity before route-specific status/reduction. No data read, result/receipt body, new quote/order, funds or entitlement restoration. Token validity alone does not prove original relation. Current organisation suspension denies new work/result routes with existing entitlement_denied403, no reference and unchanged/not_started usage; invalid principal authority uses authority_revoked403. Unknown/foreign originals remain resource_not_found404 before an action-specific denial. Existing getClassificationOrder returns only its owned obligation envelope with items_path=null; cancellation preserves original cut-off and counters. General getOperation/getReceipt remain denied when they would expose result-bearing bodies; recovery uses the existing owned order route, never a new endpoint. This operation policy is denied_new_work_or_result.
Entity-Service-Profile carries the accepted profile_id; the endpoint pins its separate immutable revision. The retained template parameter description says “revision”; follow this current interpretation when reading that historical wording. No reserved example URL in the definitions is a live service destination.
Authentication
Apply the operation’s security requirement when present, otherwise the contract default below. These definitions do not provision access or qualify an authentication flow.
[
{
"bearerAuth": []
}
]Security scheme definitions
{
"bearerAuth": {
"type": "http",
"scheme": "bearer",
"description": "Validated OAuth access token, never an ID token. Issuer/audience/token endpoint and scope mapping are deployment-profile values. ENTITY current role, data and budget policy additionally applies."
}
}Request parameters
Headers, path and query parameters from the candidate contract. Operation-specific definitions take precedence over inherited definitions with the same name and location. Request body fields appear in the reading view below.
operation_id
path · Required
Reading definition for operation_id
{
"name": "operation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"maxLength": 36
}
}Request and response contract
The candidate operation is shown below with the declared documentation-only public-meaning projection. References open the corresponding public schema. No server URL or credential is supplied by this page.
{
"operationId": "getOperation",
"summary": "Inspect own operation",
"parameters": [
{
"name": "operation_id",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"maxLength": 36
}
}
],
"responses": {
"200": {
"description": "Successful governed response; examples are synthetic and no endpoint is deployed by this specification.",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OperationResponse"
},
"example": {
"data": {
"operation_id": "00000006-1111-4111-8111-000000000006",
"state": "reconciling",
"financial_state": "uncertain",
"receipt_id": null,
"original_period_id": "00000008-1111-4111-8111-000000000008",
"reserved_units": "1",
"settled_units": null,
"result_replay_available": false,
"replay_status": "pending",
"retry_action": "poll_status",
"updated_at": "2026-09-07T10:00:00Z"
},
"meta": {
"request_id": "00000007-1111-4111-8111-000000000007",
"served_at": "2026-09-07T10:00:00Z",
"profile_revision": "synthetic-review-1",
"synthetic": true,
"replayed": false,
"warnings": [
"Illustration only; limits, retention and units are not approved production terms."
]
}
}
}
}
},
"400": {
"description": "invalid_request",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
},
"WWW-Authenticate": {
"schema": {
"type": "string"
},
"description": "Bearer challenge for 401 responses."
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Problem"
},
{
"properties": {
"code": {
"enum": [
"invalid_request"
]
},
"status": {
"const": 400
}
}
}
]
},
{
"properties": {
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
},
"code": {
"not": {
"enum": [
"operation_in_progress",
"operation_reconciling",
"completion_uncertain",
"budget_exhausted",
"funding_window_too_short"
]
}
}
}
}
]
},
"example": {
"type": "urn:sustema:entity:problem:invalid_request",
"title": "Malformed JSON, duplicate keys, timestamp, header or structural input.",
"status": 400,
"code": "invalid_request",
"request_id": "00000007-1111-4111-8111-000000000007",
"operation_id": null,
"retry_action": "do_not_retry",
"usage_state": "not_started"
}
}
},
"x-error-codes": [
"invalid_request"
]
},
"401": {
"description": "unauthenticated",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
},
"WWW-Authenticate": {
"schema": {
"type": "string"
},
"description": "Bearer challenge for 401 responses."
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Problem"
},
{
"properties": {
"code": {
"enum": [
"unauthenticated"
]
},
"status": {
"const": 401
}
}
}
]
},
{
"properties": {
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
},
"code": {
"not": {
"enum": [
"operation_in_progress",
"operation_reconciling",
"completion_uncertain",
"budget_exhausted",
"funding_window_too_short"
]
}
}
}
}
]
},
"example": {
"type": "urn:sustema:entity:problem:unauthenticated",
"title": "Missing/invalid access token; no protected resource details.",
"status": 401,
"code": "unauthenticated",
"request_id": "00000007-1111-4111-8111-000000000007",
"operation_id": null,
"retry_action": "reauthenticate",
"usage_state": "not_started"
}
}
},
"x-error-codes": [
"unauthenticated"
]
},
"403": {
"description": "Current original operation access denied: permission_denied, authority_revoked or entitlement_denied, including non-retired company suspension; schema and retry/current-scope rules apply.",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
},
"WWW-Authenticate": {
"schema": {
"type": "string"
},
"description": "Bearer challenge for 401 responses."
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Problem"
},
{
"properties": {
"code": {
"enum": [
"permission_denied",
"authority_revoked",
"entitlement_denied"
]
},
"status": {
"const": 403
}
}
}
]
},
{
"properties": {
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
},
"code": {
"not": {
"enum": [
"operation_in_progress",
"operation_reconciling",
"completion_uncertain",
"budget_exhausted",
"funding_window_too_short"
]
}
}
}
}
]
},
"example": {
"type": "urn:sustema:entity:problem:permission_denied",
"title": "Authenticated principal lacks the action/resource grant.",
"status": 403,
"code": "permission_denied",
"request_id": "00000007-1111-4111-8111-000000000007",
"operation_id": null,
"retry_action": "do_not_retry",
"usage_state": "not_started"
}
}
},
"x-error-codes": [
"permission_denied",
"authority_revoked",
"entitlement_denied"
]
},
"404": {
"description": "resource_not_found",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
},
"WWW-Authenticate": {
"schema": {
"type": "string"
},
"description": "Bearer challenge for 401 responses."
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Problem"
},
{
"properties": {
"code": {
"enum": [
"resource_not_found"
]
},
"status": {
"const": 404
}
}
}
]
},
{
"properties": {
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
},
"code": {
"not": {
"enum": [
"operation_in_progress",
"operation_reconciling",
"completion_uncertain",
"budget_exhausted",
"funding_window_too_short"
]
}
}
}
}
]
},
"example": {
"type": "urn:sustema:entity:problem:resource_not_found",
"title": "Unknown resource, or tenant-private reference intentionally concealed.",
"status": 404,
"code": "resource_not_found",
"request_id": "00000007-1111-4111-8111-000000000007",
"operation_id": null,
"retry_action": "do_not_retry",
"usage_state": "not_started"
}
}
},
"x-error-codes": [
"resource_not_found"
]
},
"410": {
"description": "operation_expired",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
},
"WWW-Authenticate": {
"schema": {
"type": "string"
},
"description": "Bearer challenge for 401 responses."
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Problem"
},
{
"properties": {
"code": {
"enum": [
"operation_expired"
]
},
"status": {
"const": 410
}
}
}
]
},
{
"properties": {
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
},
"code": {
"not": {
"enum": [
"operation_in_progress",
"operation_reconciling",
"completion_uncertain",
"budget_exhausted",
"funding_window_too_short"
]
}
}
}
}
]
},
"example": {
"type": "urn:sustema:entity:problem:operation_expired",
"title": "Old logical request outside retained/admission window; not newly charged.",
"status": 410,
"code": "operation_expired",
"request_id": "00000007-1111-4111-8111-000000000007",
"operation_id": null,
"retry_action": "do_not_retry",
"usage_state": "unchanged",
"status_path": null
}
}
},
"x-error-codes": [
"operation_expired"
]
},
"422": {
"description": "Bounded zero-unit refusal: input-phase not_started; delivery-phase unchanged; no financial effect or reverse operation reference.",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
},
"WWW-Authenticate": {
"schema": {
"type": "string"
},
"description": "Bearer challenge for 401 responses."
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"allOf": [
{
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Problem"
},
{
"properties": {
"code": {
"enum": [
"invalid_request",
"unauthenticated",
"permission_denied",
"authority_revoked",
"resource_not_found",
"operation_expired",
"rate_limited",
"concurrency_limited",
"dependency_unavailable",
"internal_error",
"limit_out_of_range"
]
}
}
}
]
},
{
"properties": {
"code": {
"const": "limit_out_of_range"
},
"status": {
"const": 422
},
"retry_action": {
"const": "do_not_retry"
},
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
}
}
},
{
"properties": {
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
}
}
}
]
},
{
"properties": {
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
},
"code": {
"not": {
"enum": [
"operation_in_progress",
"operation_reconciling",
"completion_uncertain",
"budget_exhausted",
"funding_window_too_short"
]
}
}
}
}
]
},
{
"if": {
"properties": {
"code": {
"const": "limit_out_of_range"
},
"delivery_limit": {
"properties": {
"phase": {
"const": "delivery"
}
},
"required": [
"phase"
]
}
},
"required": [
"code",
"delivery_limit"
]
},
"then": {
"properties": {
"usage_state": {
"const": "unchanged"
}
}
}
}
]
}
}
}
},
"429": {
"description": "rate_limited; concurrency_limited",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
},
"WWW-Authenticate": {
"schema": {
"type": "string"
},
"description": "Bearer challenge for 401 responses."
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Problem"
},
{
"properties": {
"code": {
"enum": [
"rate_limited",
"concurrency_limited"
]
},
"status": {
"const": 429
}
}
}
]
},
{
"properties": {
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
},
"code": {
"not": {
"enum": [
"operation_in_progress",
"operation_reconciling",
"completion_uncertain",
"budget_exhausted",
"funding_window_too_short"
]
}
}
}
}
]
},
"example": {
"type": "urn:sustema:entity:problem:rate_limited",
"title": "Throughput admission refused.",
"status": 429,
"code": "rate_limited",
"request_id": "00000007-1111-4111-8111-000000000007",
"operation_id": null,
"retry_action": "wait_then_retry_same_operation",
"usage_state": "not_started"
}
}
},
"x-error-codes": [
"rate_limited",
"concurrency_limited"
]
},
"500": {
"description": "internal_error",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
},
"WWW-Authenticate": {
"schema": {
"type": "string"
},
"description": "Bearer challenge for 401 responses."
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Problem"
},
{
"properties": {
"code": {
"enum": [
"internal_error"
]
},
"status": {
"const": 500
}
}
}
]
},
{
"properties": {
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
},
"code": {
"not": {
"enum": [
"operation_in_progress",
"operation_reconciling",
"completion_uncertain",
"budget_exhausted",
"funding_window_too_short"
]
}
}
}
}
]
},
"example": {
"type": "urn:sustema:entity:problem:internal_error",
"title": "Safe internal failure; no stack or protected payload.",
"status": 500,
"code": "internal_error",
"request_id": "00000007-1111-4111-8111-000000000007",
"operation_id": null,
"retry_action": "wait_then_retry_same_operation",
"usage_state": "not_started"
}
}
},
"x-error-codes": [
"internal_error"
]
},
"503": {
"description": "dependency_unavailable",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
},
"WWW-Authenticate": {
"schema": {
"type": "string"
},
"description": "Bearer challenge for 401 responses."
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Problem"
},
{
"properties": {
"code": {
"enum": [
"dependency_unavailable"
]
},
"status": {
"const": 503
}
}
}
]
},
{
"properties": {
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
},
"code": {
"not": {
"enum": [
"operation_in_progress",
"operation_reconciling",
"completion_uncertain",
"budget_exhausted",
"funding_window_too_short"
]
}
}
}
}
]
},
"example": {
"type": "urn:sustema:entity:problem:dependency_unavailable",
"title": "Required policy, publication, ledger or search dependency unavailable.",
"status": 503,
"code": "dependency_unavailable",
"request_id": "00000007-1111-4111-8111-000000000007",
"operation_id": null,
"retry_action": "wait_then_retry_same_operation",
"usage_state": "not_started"
}
}
},
"x-error-codes": [
"dependency_unavailable"
]
},
"default": {
"description": "RFC 9457 problem; exact code/status/usage rules in errors.json. Current authority applies to all errors and replay.",
"headers": {
"Cache-Control": {
"schema": {
"const": "private, no-store"
}
},
"Entity-Request-Id": {
"schema": {
"type": "string",
"format": "uuid"
}
},
"Retry-After": {
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 128
},
"description": "Provided only when a specific retry delay is known; never implies extra spending authority. Only valid delay-seconds or HTTP-date, no CR/LF; same128-character MCP bound. Unknown timing is omitted, not truncated."
},
"WWW-Authenticate": {
"schema": {
"type": "string"
},
"description": "Bearer challenge for 401 responses."
}
},
"content": {
"application/problem+json": {
"schema": {
"allOf": [
{
"allOf": [
{
"$ref": "#/components/schemas/Problem"
},
{
"properties": {
"code": {
"enum": [
"invalid_request",
"unauthenticated",
"permission_denied",
"authority_revoked",
"resource_not_found",
"operation_expired",
"rate_limited",
"concurrency_limited",
"dependency_unavailable",
"internal_error",
"limit_out_of_range",
"entitlement_denied"
]
}
}
}
]
},
{
"properties": {
"usage_state": {
"enum": [
"not_started",
"unchanged"
]
},
"operation_id": {
"type": "null"
},
"status_path": {
"type": "null"
},
"code": {
"not": {
"enum": [
"operation_in_progress",
"operation_reconciling",
"completion_uncertain",
"budget_exhausted",
"funding_window_too_short"
]
}
}
}
}
]
}
}
}
}
},
"x-permission": "operation.read",
"x-billable": false,
"x-cross-adapter-bound": {
"operation": "getOperation",
"rule": "#/x-delivery-bound-contract",
"before_settlement": true
},
"description": "For classification orders, the class(a) cutoff returns operation_expired/410 even if a subject-free receipt survives; never reconstruct ICOperationResult from that receipt. This pure owned read creates no new business effect or debit. Its failure reports only not_started/unchanged with null operation/status references. Existing underlying financial uncertainty is shown in the successful owned status envelope; unavailable read dependencies use the existing dependency_unavailable retry path. Never report a new reservation/settlement or invent a polling operation for this read. Original-resource disclosure: The caller must have the exact original integration service-principal relation, or the exact operation_id of its own original classification order, with current status permission. No separate named operation kind or human-steward substitute. Returned results independently require their current result/source guards; no foreign key recovery or cross-tenant operation metadata. Resolve authentication and exact same-workspace/environment owned relation before action-specific disclosure. Missing/foreign relation is the same opaque resource_not_found404. Only a proved owned relation may return an action-specific permission_denied403. No role or guessed identifier reveals another creator object; an entirely unauthenticated request remains unauthenticated401. Every current credential/action/profile/source/retention guard still applies. Non-retired suspension: A non-retired organisation security/financial suspension admits only the original authenticated integration service principal status/cancellation corridor below. Credential/session/principal revocation, compromised identity or retired binding has its own stricter denial and is never bypassed. Verify the original workspace/environment and integration service-principal identity before route-specific status/reduction. No data read, result/receipt body, new quote/order, funds or entitlement restoration. Token validity alone does not prove original relation. Current organisation suspension denies new work/result routes with existing entitlement_denied403, no reference and unchanged/not_started usage; invalid principal authority uses authority_revoked403. Unknown/foreign originals remain resource_not_found404 before an action-specific denial. Existing getClassificationOrder returns only its owned obligation envelope with items_path=null; cancellation preserves original cut-off and counters. General getOperation/getReceipt remain denied when they would expose result-bearing bodies; recovery uses the existing owned order route, never a new endpoint. This operation policy is denied_new_work_or_result.",
"x-original-resource-relation": "The caller must have the exact original integration service-principal relation, or the exact operation_id of its own original classification order, with current status permission. No separate named operation kind or human-steward substitute. Returned results independently require their current result/source guards; no foreign key recovery or cross-tenant operation metadata. Resolve authentication and exact same-workspace/environment owned relation before action-specific disclosure. Missing/foreign relation is the same opaque resource_not_found404. Only a proved owned relation may return an action-specific permission_denied403. No role or guessed identifier reveals another creator object; an entirely unauthenticated request remains unauthenticated401.",
"x-owned-relation-precedence": "Resolve authentication and exact same-workspace/environment owned relation before action-specific disclosure. Missing/foreign relation is the same opaque resource_not_found404. Only a proved owned relation may return an action-specific permission_denied403. No role or guessed identifier reveals another creator object; an entirely unauthenticated request remains unauthenticated401.",
"x-non-retired-suspension": {
"policy": "denied_new_work_or_result",
"rule": "A non-retired organisation security/financial suspension admits only the original authenticated integration service principal status/cancellation corridor below. Credential/session/principal revocation, compromised identity or retired binding has its own stricter denial and is never bypassed. Verify the original workspace/environment and integration service-principal identity before route-specific status/reduction. No data read, result/receipt body, new quote/order, funds or entitlement restoration. Token validity alone does not prove original relation. Current organisation suspension denies new work/result routes with existing entitlement_denied403, no reference and unchanged/not_started usage; invalid principal authority uses authority_revoked403. Unknown/foreign originals remain resource_not_found404 before an action-specific denial. Existing getClassificationOrder returns only its owned obligation envelope with items_path=null; cancellation preserves original cut-off and counters. General getOperation/getReceipt remain denied when they would expose result-bearing bodies; recovery uses the existing owned order route, never a new endpoint."
}
}Referenced schemas
Includes schemas used by this operation and its shared or inherited parameters. Open a schema to follow its related definitions.
Shared parameter definitions
{
"Cursor": {
"name": "cursor",
"in": "query",
"required": false,
"schema": {
"type": "string",
"maxLength": 4096,
"x-profile-maxLength": "string_characters_max"
},
"description": "Opaque signed cursor bound to query, organisation, environment, profile, rights and index/publication generation."
},
"IdempotencyKey": {
"name": "Idempotency-Key",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"maxLength": 36
},
"description": "Random UUID for one logical operation, including billed GETs. Same request/key/time replays without a second charge; ENTITY application semantics."
},
"Manifest": {
"name": "manifest_id",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"maxLength": 36
},
"description": "Manifest returned by identity/search. A compatibility-bound follow-on read, not unrestricted historical query. Current rights and retention apply."
},
"MaxUnits": {
"name": "Entity-Max-Units",
"in": "header",
"required": false,
"schema": {
"$ref": "#/components/schemas/Units"
},
"description": "Caller ceiling in the accepted offer atomic unit; cannot increase organisation authority."
},
"OperationCreated": {
"name": "Entity-Operation-Created-At",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "date-time",
"maxLength": 35
},
"description": "Original creation instant, unchanged on retry. New keys outside the profile admission/skew window are refused even after tombstone expiry."
},
"PageSize": {
"name": "page_size",
"in": "query",
"required": false,
"schema": {
"type": "integer",
"minimum": 1,
"x-profile-maximum": "page_size_max"
},
"description": "Default and maximum from the active profile."
},
"ReceiptContext": {
"name": "Entity-Receipt-Context",
"in": "header",
"required": true,
"schema": {
"type": "string",
"format": "uuid",
"maxLength": 36
},
"description": "Readable own-organisation receipt containing the requested entity/manifest. Binds follow-on evidence/module reads to a known permitted result within its retention window; this is not unrestricted historical access."
},
"ServiceProfile": {
"name": "Entity-Service-Profile",
"in": "header",
"required": true,
"schema": {
"type": "string",
"maxLength": 4096,
"x-profile-maxLength": "string_characters_max"
},
"description": "Accepted immutable service-profile revision; missing/unknown profiles cannot activate an operation."
}
}Inherited path parameters
[]