Unreleased documentation. These pages follow the main branch and can change before the next release. For supported guidance, use v0.26.1.
Add a note to this Requester's hosted item
const url = 'https://casework.example.test/v1/hosted-items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/notes';const options = { method: 'POST', headers: { 'Registry-Casework-Profile': 'example', 'If-Match': 'example', 'Idempotency-Key': 'example', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"note":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://casework.example.test/v1/hosted-items/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/notes \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Idempotency-Key: example' \ --header 'If-Match: example' \ --header 'Registry-Casework-Profile: example' \ --data '{ "note": "example" }'Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Casework item UUID.
Header Parameters
Section titled “Header Parameters”Optional W3C trace context continued in the response.
Explicit Casework access profile. It never selects BReg authority.
Quoted positive signed 64-bit Casework item revision.
Caller-selected ASCII graphic key bound to this principal, selected profile, operation, resource, and exact request. After the item payload expires, an exact retry until the accountability retention deadline returns idempotency.expired; a changed request remains idempotency.key-reused. After that deadline the record is forgotten and the key may be reused.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Examplegenerated
{ "note": "example"}Responses
Section titled “Responses”Success
object
object
Example
{ "state": "open"}Headers
Section titled “Headers”W3C trace context for the request and response.
Problem response: request.invalid, source-profile.not-applicable
object
object
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”Bounded JSON path for a typed hosted validation failure. Present together with Registry-Casework-Validation-Reason; rejected values are never echoed.
Stable, value-free reason for a typed hosted validation failure. Present together with Registry-Casework-Validation-Path.
W3C trace context for the request and response.
Problem response: authentication.refused
object
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”Bearer authentication challenge.
W3C trace context for the request and response.
Problem response: profile.not-authorized, profile.not-human, operation.not-authorized
object
object
object
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”W3C trace context for the request and response.
Problem response: work-item.not-visible
object
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”W3C trace context for the request and response.
Problem response: request.method-not-allowed
object
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”W3C trace context for the request and response.
Problem response: idempotency.key-reused, work-item.already-claimed, work-item.not-holder, work-item.not-offered
object
object
object
object
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”W3C trace context for the request and response.
Problem response: idempotency.expired
object
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”W3C trace context for the request and response.
Problem response: precondition.failed
object
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”W3C trace context for the request and response.
Problem response: request.body-too-large
object
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”W3C trace context for the request and response.
Problem response: request.unsupported-media-type
object
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”W3C trace context for the request and response.
Problem response: request.unprocessable
object
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”W3C trace context for the request and response.
Problem response: precondition.required
object
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”W3C trace context for the request and response.
Problem response: runtime.failure
object
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”W3C trace context for the request and response.
Problem response: service.unavailable
object
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”Seconds before retrying the unavailable dependency.
W3C trace context for the request and response.