Skip to content
Registry StackDocsDevelopment (unreleased)

Perform a freshly authorized source action

POST
/v1/work-items/{item_id}/decisions
curl --request POST \
  --url https://casework.example.test/v1/work-items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/decisions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --header 'If-Match: example' \
  --header 'Registry-Casework-Profile: example' \
  --header 'Registry-Source-Profile: example' \
  --data '{ "displayedBinding": { "generation": "example", "integrity": "example", "sourceRevision": "example", "version": "example" }, "flaggedFields": [ "example" ], "operation": "example", "reason": "example", "sourceProfileId": "example" }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
item_id
required
string format: uuid

Casework item UUID.

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.

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

Explicit source profile used for the caller-scoped BReg read or action.

If-Match
required
string
<= 21 characters /^"(0|[1-9][0-9]{0,18})"$/

Quoted nonnegative signed 64-bit Casework item or directory revision.

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
displayedBinding
required
object
generation
required
string
integrity
Any of:
string
sourceRevision
required
string
version
required
string
flaggedFields
Array<string>
operation
required
string
<= 64 characters /^[a-z][a-z0-9_]{0,63}$/
reason
Any of:
string
sourceProfileId
required
string
>= 1 characters <= 128 characters /^[A-Za-z0-9_.:-]+$/
Examplegenerated
{
  "displayedBinding": {
    "generation": "example",
    "integrity": "example",
    "sourceRevision": "example",
    "version": "example"
  },
  "flaggedFields": [
    "example"
  ],
  "operation": "example",
  "reason": "example",
  "sourceProfileId": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
attempt
Any of:
object
attemptId
required
string format: uuid
createdAt
required
string format: date-time
itemId
required
string format: uuid
itemRevision
required
integer format: int64
operation
required
string
<= 64 characters /^[a-z][a-z0-9_]{0,63}$/
receipt
Any of:
object
actorReference
Any of:
string
binding
required
object
generation
required
string
integrity
Any of:
string
sourceRevision
required
string
version
required
string
metadata
required
object
key
additional properties
any
resultingState
required
string
sourceRevision
required
string
state
required
string
Allowed values: pending uncertain completed refused
item
required
object
actions
required
Array<object>
object
href
required
string
ifMatch
required
string
operation
required
string
assignment
Any of:
object
absenceIds
required
Array<string>
assignedBy
Any of:
object
issuer
required
string
subject
required
string
owner
Any of:
object
issuer
required
string
subject
required
string
staffingDiagnostic
Any of:
string
Allowed values: no_cover_available
binding
required
object
generation
required
string
integrity
Any of:
string
sourceRevision
required
string
version
required
string
bindingReference
required
string
clockOccurrences
Array<object>
object
anchorAt
Any of:
string format: date-time
atRiskAt
Any of:
string format: date-time
calculationGeneration
required
integer format: int64
clockId
required
string
clockOccurrenceId
required
string format: uuid
completedAt
Any of:
string format: date-time
dueAt
Any of:
string format: date-time
nextEffect
Any of:
One of:
object
at
required
string format: date-time
id
required
string
kind
required
Allowed value: reminder
policyDigest
required
string
>= 71 characters <= 71 characters /^sha256:[0-9a-f]{64}$/
recomputeGeneration
required
integer format: int64
startedAt
Any of:
string format: date-time
state
required
string
Allowed values: running paused completed cancelled verification_pending source_facts_missing
subject
required
object
id
required
string
kind
required
string
sourceId
required
string
upcomingEffects

For running or verification-pending clocks, the earliest unapplied reminder and earliest unapplied reassignment, ordered by time, effect kind, and identifier. Omitted when no firing instant can be promised, including while paused. These are pinned authored instants, not scheduler retry times.

Array
<= 2 items
One of:
object
at
required
string format: date-time
id
required
string
kind
required
Allowed value: reminder
displayReference

Human-facing source reference disclosed by the source to the current caller. Present only for source-backed items whose request policy explicitly names a reference field and whose current caller read discloses that field.

string
>= 1 characters <= 512 characters /^[^\u0000-\u001F\u007F-\u009F]+$/
firstObservedAt
required
string format: date-time
heldSince
string format: date-time
holder
Any of:
object
issuer
required
string
subject
required
string
hosted
Any of:
object
display
required
object
key
additional properties
any
kind
required
string
kindPolicyDigest
required
string
>= 71 characters <= 71 characters /^sha256:[0-9a-f]{64}$/
outcomes
required
Array<object>
object
id
required
string
label
required
string
reasonRequired
required
boolean
requesterReference
required
string
version
required
string
itemId
required
string format: uuid
liveAttempt
object
attemptId
required
string format: uuid
createdAt
required
string format: date-time
itemId
required
string format: uuid
itemRevision
required
integer format: int64
operation
required
string
<= 64 characters /^[a-z][a-z0-9_]{0,63}$/
receipt
Any of:
object
actorReference
Any of:
string
binding
required
object
generation
required
string
integrity
Any of:
string
sourceRevision
required
string
version
required
string
metadata
required
object
key
additional properties
any
resultingState
required
string
sourceRevision
required
string
state
required
string
Allowed values: pending uncertain completed refused
occurrenceKind
required
string
Allowed values: review application hosted
passiveDueAt
Any of:
string format: date-time
queueId
required
string
revision
required
integer format: int64
routing
Any of:
object
because
Any of:
string
policyDigest
Any of:
string
>= 71 characters <= 71 characters /^sha256:[0-9a-f]{64}$/
ruleId
Any of:
string
routingCopy
Any of:
object
flaggedFields
required
Array<string>
reason
Any of:
string
sourceBinding
required
object
generation
required
string
integrity
Any of:
string
sourceRevision
required
string
version
required
string
stage
Any of:
string
state
required
string
Allowed values: open claimed waiting_applicant waiting_application synchronizing completed superseded cancelled
subject
required
object
id
required
string
kind
required
string
sourceId
required
string
updatedAt
required
string format: date-time
Example
{
  "attempt": {
    "state": "pending"
  },
  "item": {
    "assignment": {
      "staffingDiagnostic": "no_cover_available"
    },
    "clockOccurrences": [
      {
        "nextEffect": {
          "kind": "reminder"
        },
        "state": "running",
        "upcomingEffects": [
          {
            "kind": "reminder"
          }
        ]
      }
    ],
    "liveAttempt": {
      "state": "pending"
    },
    "occurrenceKind": "review",
    "state": "open"
  }
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

400

Section titled “400”

Problem response: request.invalid, source-profile.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 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”
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 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: profile.not-authorized, profile.not-human, source.reviewer-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 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: profile.not-authorized
detail
required
Allowed value: The selected Casework profile does not authorize this request.
status
required
Allowed value: 403
title
required
Allowed value: Profile not authorized
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/profile/not-authorized
Example
{
  "code": "profile.not-authorized",
  "detail": "The selected Casework profile does not authorize this request.",
  "status": 403,
  "title": "Profile not authorized",
  "type": "https://id.registrystack.org/problems/registry-casework/profile/not-authorized"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

404

Section titled “404”

Problem response: source.record-missing, work-item.not-visible

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 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: source.record-missing
detail
required
Allowed value: The bound source record is no longer at the registered location.
status
required
Allowed value: 404
title
required
Allowed value: Source record missing
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/source/record-missing
Example
{
  "code": "source.record-missing",
  "detail": "The bound source record is no longer at the registered location.",
  "status": 404,
  "title": "Source record missing",
  "type": "https://id.registrystack.org/problems/registry-casework/source/record-missing"
}

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 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, work-item.not-holder, work-item.not-offered, work-item.proposal-changed, work-item.recovery-pending, work-item.superseded

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 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”
Registry-Casework-Attempt
string format: uuid

Original attempt UUID, present only when the entitled recovery-pending response can disclose it.

traceparent
string

W3C trace context for the request and response.

412

Section titled “412”

Problem response: precondition.failed

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 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: precondition.failed
detail
required
Allowed value: The item or directory changed since you loaded it. Reload and try again.
status
required
Allowed value: 412
title
required
Allowed value: Precondition failed
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/precondition/failed
Example
{
  "code": "precondition.failed",
  "detail": "The item or directory changed since you loaded it. Reload and try again.",
  "status": 412,
  "title": "Precondition failed",
  "type": "https://id.registrystack.org/problems/registry-casework/precondition/failed"
}

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 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 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.reason-unsupported, request.source-rejected, request.unprocessable

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 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.reason-unsupported
detail
required
Allowed value: The reason field is not supported for approve or apply on this source. Omit it and try again.
status
required
Allowed value: 422
title
required
Allowed value: Reason not supported
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/request/reason-unsupported
Example
{
  "code": "request.reason-unsupported",
  "detail": "The reason field is not supported for approve or apply on this source. Omit it and try again.",
  "status": 422,
  "title": "Reason not supported",
  "type": "https://id.registrystack.org/problems/registry-casework/request/reason-unsupported"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

428

Section titled “428”

Problem response: precondition.required

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 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: precondition.required
detail
required
Allowed value: This mutation requires the revision that you loaded.
status
required
Allowed value: 428
title
required
Allowed value: Precondition required
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/precondition/required
Example
{
  "code": "precondition.required",
  "detail": "This mutation requires the revision that you loaded.",
  "status": 428,
  "title": "Precondition required",
  "type": "https://id.registrystack.org/problems/registry-casework/precondition/required"
}

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 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.

502

Section titled “502”

Problem response: source.bad-gateway

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 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: source.bad-gateway
detail
required
Allowed value: The source returned a response that does not match its registered contract.
status
required
Allowed value: 502
title
required
Allowed value: Invalid source response
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/source/bad-gateway
Example
{
  "code": "source.bad-gateway",
  "detail": "The source returned a response that does not match its registered contract.",
  "status": 502,
  "title": "Invalid source response",
  "type": "https://id.registrystack.org/problems/registry-casework/source/bad-gateway"
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

503

Section titled “503”

Problem response: service.unavailable, work-item.source-unavailable

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 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”
Registry-Casework-Attempt
string format: uuid

Durable attempt UUID when this source mutation was stored but its post-write authoritative read was unavailable.

Retry-After
integer

Seconds before retrying the unavailable dependency.

traceparent
string

W3C trace context for the request and response.