Skip to content
Registry StackDocsDevelopment (unreleased)

Create or recover a unified review request

POST
/v1/review-requests
curl --request POST \
  --url https://casework.example.test/v1/review-requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --header 'Registry-Casework-Profile: example' \
  --data '{ "context": { "snapshot": {}, "strategy": "submitted" }, "initiator": { "issuer": "example", "subject": "example" }, "kind": "example", "requesterReference": "example", "resultConstraints": {}, "subject": { "digest": "example", "id": "example", "source": "example", "type": "example", "version": "example" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
traceparent
string

Optional W3C trace context continued in the response.

Registry-Casework-Profile
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_.:-]+$/

Explicit Casework access profile. It never selects BReg authority.

Idempotency-Key
required
string
>= 1 characters <= 128 characters /^[!-~]+$/

Caller-selected ASCII graphic key bound to this exact mutation.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
context
required
One of: discriminator: strategy
object
snapshot
required

Every nested integer must be in the exactly portable range -9007199254740991 through 9007199254740991.

object
key
additional properties
any
strategy
required
string
Allowed values: submitted
initiator
Any of:
object
issuer
required
string
subject
required
string
kind
required
string
requesterReference
required
string
resultConstraints
Any of:

Every nested integer must be in the exactly portable range -9007199254740991 through 9007199254740991.

object
key
additional properties
any
subject
required
object
digest
required
string
/^sha256:[0-9a-f]{64}$/
id
required
string
source
required
string
type
required
string
version
required
string

Responses

Section titled “ Responses ”

200

Section titled “200”

Recovered the exact existing request binding.

Media typeapplication/json
object
policy
required
object
digest
required
string
/^sha256:[0-9a-f]{64}$/
id
required
string
version
required
string
requestId
required
string format: uuid
subject
required
object
digest
required
string
/^sha256:[0-9a-f]{64}$/
id
required
string
source
required
string
type
required
string
version
required
string
submissionDigest
required
string
/^sha256:[0-9a-f]{64}$/
Examplegenerated
{
  "policy": {
    "digest": "example",
    "id": "example",
    "version": "example"
  },
  "requestId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "subject": {
    "digest": "example",
    "id": "example",
    "source": "example",
    "type": "example",
    "version": "example"
  },
  "submissionDigest": "example"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

201

Section titled “201”

Success

Media typeapplication/json
object
policy
required
object
digest
required
string
/^sha256:[0-9a-f]{64}$/
id
required
string
version
required
string
requestId
required
string format: uuid
subject
required
object
digest
required
string
/^sha256:[0-9a-f]{64}$/
id
required
string
source
required
string
type
required
string
version
required
string
submissionDigest
required
string
/^sha256:[0-9a-f]{64}$/
Examplegenerated
{
  "policy": {
    "digest": "example",
    "id": "example",
    "version": "example"
  },
  "requestId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "subject": {
    "digest": "example",
    "id": "example",
    "source": "example",
    "type": "example",
    "version": "example"
  },
  "submissionDigest": "example"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

400

Section titled “400”

Problem response: request.invalid, source-profile.not-applicable

Media typeapplication/problem+json
One of:
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: request.invalid
detail
required
Allowed value: The Casework request is invalid.
status
required
Allowed value: 400
title
required
Allowed value: Invalid request
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/request/invalid
Example
{
  "code": "request.invalid",
  "detail": "The Casework request is invalid.",
  "status": 400,
  "title": "Invalid request",
  "type": "https://id.registrystack.org/problems/registry-casework/request/invalid"
}

Headers

Section titled “Headers”
Registry-Casework-Validation-Path
string
<= 256 characters

Bounded JSON path for a typed review validation failure. Present together with Registry-Casework-Validation-Reason; rejected values are never echoed.

Registry-Casework-Validation-Reason
string
Allowed values: kind_not_allowed reference_invalid object_required maximum_bytes_exceeded maximum_depth_exceeded schema_mismatch outcome_not_declared reason_required text_invalid result_not_declared result_required field_not_declared constraint_invalid constraint_violated

Stable, value-free reason for a typed review validation failure. Present together with Registry-Casework-Validation-Path.

traceparent
string

W3C trace context for the request and response.

401

Section titled “401”

Problem response: authentication.refused

Media typeapplication/problem+json
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: authentication.refused
detail
required
Allowed value: The bearer credential is missing, invalid, or expired. Sign in again.
status
required
Allowed value: 401
title
required
Allowed value: Authentication refused
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/authentication/refused
Example
{
  "code": "authentication.refused",
  "detail": "The bearer credential is missing, invalid, or expired. Sign in again.",
  "status": 401,
  "title": "Authentication refused",
  "type": "https://id.registrystack.org/problems/registry-casework/authentication/refused"
}

Headers

Section titled “Headers”
WWW-Authenticate
Allowed value: Bearer

Bearer authentication challenge.

traceparent
string

W3C trace context for the request and response.

403

Section titled “403”

Problem response: operation.not-authorized, profile.not-authorized

Media typeapplication/problem+json
One of:
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: operation.not-authorized
detail
required
Allowed value: Your current Casework authority does not allow this operation.
status
required
Allowed value: 403
title
required
Allowed value: Operation not authorized
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/operation/not-authorized
Example
{
  "code": "operation.not-authorized",
  "detail": "Your current Casework authority does not allow this operation.",
  "status": 403,
  "title": "Operation not authorized",
  "type": "https://id.registrystack.org/problems/registry-casework/operation/not-authorized"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

404

Section titled “404”

Problem response: work-item.not-visible

Media typeapplication/problem+json
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: work-item.not-visible
detail
required
Allowed value: The registry did not show you this request, so Casework cannot show you the item.
status
required
Allowed value: 404
title
required
Allowed value: Work item not visible
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/work-item/not-visible
Example
{
  "code": "work-item.not-visible",
  "detail": "The registry did not show you this request, so Casework cannot show you the item.",
  "status": 404,
  "title": "Work item not visible",
  "type": "https://id.registrystack.org/problems/registry-casework/work-item/not-visible"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

405

Section titled “405”

Problem response: request.method-not-allowed

Media typeapplication/problem+json
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: request.method-not-allowed
detail
required
Allowed value: This route does not accept that HTTP method.
status
required
Allowed value: 405
title
required
Allowed value: Method not allowed
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/request/method-not-allowed
Example
{
  "code": "request.method-not-allowed",
  "detail": "This route does not accept that HTTP method.",
  "status": 405,
  "title": "Method not allowed",
  "type": "https://id.registrystack.org/problems/registry-casework/request/method-not-allowed"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

409

Section titled “409”

Problem response: idempotency.key-reused, review.submission-conflict

Media typeapplication/problem+json
One of:
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: idempotency.key-reused
detail
required
Allowed value: This idempotency key was used for a different request.
status
required
Allowed value: 409
title
required
Allowed value: Idempotency key reused
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/idempotency/key-reused
Example
{
  "code": "idempotency.key-reused",
  "detail": "This idempotency key was used for a different request.",
  "status": 409,
  "title": "Idempotency key reused",
  "type": "https://id.registrystack.org/problems/registry-casework/idempotency/key-reused"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

410

Section titled “410”

Problem response: idempotency.expired, review.result-expired

Media typeapplication/problem+json
One of:
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: idempotency.expired
detail
required
Allowed value: The stored response for this idempotency key has expired. Reconcile the original operation before choosing a new key.
status
required
Allowed value: 410
title
required
Allowed value: Idempotency window expired
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/idempotency/expired
Example
{
  "code": "idempotency.expired",
  "detail": "The stored response for this idempotency key has expired. Reconcile the original operation before choosing a new key.",
  "status": 410,
  "title": "Idempotency window expired",
  "type": "https://id.registrystack.org/problems/registry-casework/idempotency/expired"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

413

Section titled “413”

Problem response: request.body-too-large

Media typeapplication/problem+json
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: request.body-too-large
detail
required
Allowed value: The request body exceeds the one MiB limit.
status
required
Allowed value: 413
title
required
Allowed value: Request body too large
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/request/body-too-large
Example
{
  "code": "request.body-too-large",
  "detail": "The request body exceeds the one MiB limit.",
  "status": 413,
  "title": "Request body too large",
  "type": "https://id.registrystack.org/problems/registry-casework/request/body-too-large"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

415

Section titled “415”

Problem response: request.unsupported-media-type

Media typeapplication/problem+json
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: request.unsupported-media-type
detail
required
Allowed value: Send a JSON request body with Content-Type application/json.
status
required
Allowed value: 415
title
required
Allowed value: Unsupported media type
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/request/unsupported-media-type
Example
{
  "code": "request.unsupported-media-type",
  "detail": "Send a JSON request body with Content-Type application/json.",
  "status": 415,
  "title": "Unsupported media type",
  "type": "https://id.registrystack.org/problems/registry-casework/request/unsupported-media-type"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

422

Section titled “422”

Problem response: request.unprocessable, review.initiator-required

Media typeapplication/problem+json
One of:
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: request.unprocessable
detail
required
Allowed value: The request body does not match the Casework contract.
status
required
Allowed value: 422
title
required
Allowed value: Request could not be processed
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/request/unprocessable
Example
{
  "code": "request.unprocessable",
  "detail": "The request body does not match the Casework contract.",
  "status": 422,
  "title": "Request could not be processed",
  "type": "https://id.registrystack.org/problems/registry-casework/request/unprocessable"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

500

Section titled “500”

Problem response: runtime.failure

Media typeapplication/problem+json
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: runtime.failure
detail
required
Allowed value: Casework could not complete the request.
status
required
Allowed value: 500
title
required
Allowed value: Casework runtime failure
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/runtime/failure
Example
{
  "code": "runtime.failure",
  "detail": "Casework could not complete the request.",
  "status": 500,
  "title": "Casework runtime failure",
  "type": "https://id.registrystack.org/problems/registry-casework/runtime/failure"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

503

Section titled “503”

Problem response: service.unavailable

Media typeapplication/problem+json
object
code
required
string
Allowed values: absence.cover-cycle absence.invalid-period absence.overlap absence.self-cover authentication.refused clock.recompute-preview-expired cursor.expired cursor.invalid idempotency.expired idempotency.key-reused operation.not-authorized precondition.failed precondition.required profile.not-authorized profile.not-human request.body-too-large request.invalid request.method-not-allowed request.not-found request.reason-unsupported request.source-rejected request.unprocessable request.unsupported-media-type review.initiator-excluded review.initiator-required review.result-expired review.submission-conflict review.task-not-held runtime.failure service.unavailable source-profile.not-applicable source-profile.required source.bad-gateway source.not-found source.record-missing source.reviewer-not-authorized source.signature-invalid work-item.already-claimed work-item.not-holder work-item.not-offered work-item.not-visible work-item.proposal-changed work-item.recovery-pending work-item.source-unavailable work-item.superseded
detail
required
string
status
required
integer
title
required
string
traceId
required
string
type
required
string format: uri
code
required
Allowed value: service.unavailable
detail
required
Allowed value: Casework storage is unavailable. Try again after the service recovers.
status
required
Allowed value: 503
title
required
Allowed value: Casework service unavailable
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/service/unavailable
Example
{
  "code": "service.unavailable",
  "detail": "Casework storage is unavailable. Try again after the service recovers.",
  "status": 503,
  "title": "Casework service unavailable",
  "type": "https://id.registrystack.org/problems/registry-casework/service/unavailable"
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds before retrying the unavailable dependency.

traceparent
string

W3C trace context for the request and response.