Skip to content
Registry StackDocsv0.34.0
Search

Describe the Casework project

GET
/v1/casework
curl --request GET \
  --url https://casework.example.test/v1/casework \
  --header 'Authorization: Bearer <token>' \
  --header 'Registry-Casework-Profile: example'

Returns configured queues, source policies, calendars and clocks visible to the authenticated profile. Review kind policy is read through the dedicated review-kinds endpoints.

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.

Responses

Section titled “ Responses ”

200

Section titled “200”

Success

Media typeapplication/json
object
calendars
required
Array<object>
object
holidaySet
required
string
<= 64 characters /^[a-z][a-z0-9-]{0,63}$/
id
required
string
<= 64 characters /^[a-z][a-z0-9-]{0,63}$/
timezone
required
string format: iana-time-zone
workingWeekdays
required
Array<string>
>= 1 items <= 7 items unique items
Allowed values: monday tuesday wednesday thursday friday saturday sunday
clocks
required
Array
One of: discriminator: scope
object
after
required
object
elapsed
required
string
anchor
required
Allowed value: firstSubmittedAt
completeOn
required
Allowed value: reviewCompleted
id
required
string
<= 64 characters /^[a-z][a-z0-9-]{0,63}$/
pauseWhile
required
array
>= 1 items <= 1 items
scope
required
Allowed value: subject
policyVersion
required
string
projectId
required
string
queues
required
Array<object>
object
id
required
string
label
required
string
sources
required
Array<object>
object
adapter
required
string
description
required
string
id
required
string
requests
required
Array<object>
object
clock
Any of:
string
<= 64 characters /^[a-z][a-z0-9-]{0,63}$/
contextProjection
Array<string>
<= 32 items unique items
displayReference
Any of:
object
field
required
string
<= 64 characters /^[a-z][a-z0-9-]{0,63}$/
entity
required
string
projection
Array<string>
<= 32 items unique items
queue
required
string
routing
Array<object>
<= 64 items unique items
object
because
required
string
>= 1 characters <= 256 characters
id
required
string
<= 64 characters /^[a-z][a-z0-9-]{0,63}$/
queue
required
string
when
required
object
activity
Any of:
string
Allowed values: review apply
fields
object
<= 16 properties
key
additional properties
One of:
object
equals
required
stage
Any of:
string
target
Any of:
object
after
required
object
elapsed
required
string
id
required
string
Example
{
  "calendars": [
    {
      "workingWeekdays": [
        "monday"
      ]
    }
  ],
  "clocks": [
    {
      "anchor": "firstSubmittedAt",
      "completeOn": "reviewCompleted",
      "scope": "subject"
    }
  ],
  "sources": [
    {
      "requests": [
        {
          "routing": [
            {
              "when": {
                "activity": "review"
              }
            }
          ]
        }
      ]
    }
  ]
}

Headers

Section titled “Headers”
traceparent
string

W3C trace context for the request and response.

400

Section titled “400”

Problem response: request.invalid

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.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 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: profile.not-authorized, profile.not-human

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

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.

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.