Skip to content
Registry StackDocsDevelopment (unreleased)

Read the item's clock occurrences

GET
/v1/work-items/{item_id}/clocks
curl --request GET \
  --url https://casework.example.test/v1/work-items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/clocks \
  --header 'Authorization: Bearer <token>' \
  --header 'Registry-Casework-Profile: example' \
  --header 'Registry-Source-Profile: example'

Staff or Supervisor read under the same current source visibility as the item. Registry-Source-Profile is required. Returns occurrences ordered by clockId and clockOccurrenceId with pinned policy digest and separate calculation and recompute generations.

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.

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
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
Example
[
  {
    "nextEffect": {
      "kind": "reminder"
    },
    "state": "running",
    "upcomingEffects": [
      {
        "kind": "reminder"
      }
    ]
  }
]

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

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: 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 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 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: work-item.proposal-changed

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: work-item.proposal-changed
detail
required
Allowed value: The proposal changed since you read it. Your private draft is retained.
status
required
Allowed value: 409
title
required
Allowed value: Work item proposal changed
type
required
Allowed value: https://id.registrystack.org/problems/registry-casework/work-item/proposal-changed
Example
{
  "code": "work-item.proposal-changed",
  "detail": "The proposal changed since you read it. Your private draft is retained.",
  "status": 409,
  "title": "Work item proposal changed",
  "type": "https://id.registrystack.org/problems/registry-casework/work-item/proposal-changed"
}

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.

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”
Retry-After
integer

Seconds before retrying the unavailable dependency.

traceparent
string

W3C trace context for the request and response.