Get a record state transition
Módulo Work
GET/record-state-transitions/{id}recordStateTransitions.get
An append-only record state transition. Returns one record state transition with its `ETag`. A record state transition the caller may not see returns 404.
- Requiere la capacidad work.record.read.
- Alcances de OAuth: work.
- 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 |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the record state transition. |
| 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: RecordStateTransition
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the record state transition. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| record_id | string (uuid) | Sí | Identifier of the record. |
| from_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" |
| to_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" |
| transitioned_at | string (date-time) | Sí | When the state changed. |
| transitioned_by | string (uuid) | Sí | Identifier of the person who changed the state. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"from_state": "Scheduled",
"to_state": "Scheduled",
"transitioned_at": "2026-10-08T14:30:00Z",
"transitioned_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/record-state-transitions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.recordStateTransitions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.record_state_transitions.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos record-state-transitions get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f