Get a canon record state
Canon module
GET/canon/record-states/{record_state}canonRecordStates.get
A record state with its meaning, in lifecycle order. Returns one canon record state with its `ETag`. A canon record state the caller may not see returns 404.
- Requires the capability canon.taxonomy.read.
- OAuth scopes: canon.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| record_state | RecordState | Yes | Record state (Section 3.10). Blocked names its blocker, Deferred carries a replan reason, Canceled is retained.Constraints: one of "Proposed", "Ready", "Scheduled", "Active", "Blocked", "In Review", "Complete", "Deferred", "Canceled" |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: CanonRecordState
| Field | Type | Required | Description |
|---|---|---|---|
| record_state | RecordState | Yes | Record state (Section 3.10). Blocked names its blocker, Deferred carries a replan reason, Canceled is retained.Constraints: one of "Proposed", "Ready", "Scheduled", "Active", "Blocked", "In Review", "Complete", "Deferred", "Canceled" |
| meaning | string | Yes | Meaning of the state.Constraints: length 1 to 20000 |
{
"record_state": "Scheduled",
"meaning": "Dated and resourced."
}Code samples
curl -X GET "$XOS_BASE_URL/canon/record-states/Scheduled" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.canonRecordStates.get("Scheduled");response = xos.canon_record_states.get("Scheduled")xos canon-record-states get Scheduled