Get a canon record state
Módulo Canon
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.
- Requiere la capacidad canon.taxonomy.read.
- Alcances de OAuth: canon.
- Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| record_state | RecordState | Sí | Record state (Section 3.10). Blocked names its blocker, Deferred carries a replan reason, Canceled is retained.Restricciones: 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.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Respuesta 200: CanonRecordState
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| record_state | RecordState | Sí | Record state (Section 3.10). Blocked names its blocker, Deferred carries a replan reason, Canceled is retained.Restricciones: one of "Proposed", "Ready", "Scheduled", "Active", "Blocked", "In Review", "Complete", "Deferred", "Canceled" |
| meaning | string | Sí | Meaning of the state.Restricciones: length 1 to 20000 |
{
"record_state": "Scheduled",
"meaning": "Dated and resourced."
}Ejemplos de código
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