Transition the asset state
Módulo Assets
POST/asset-units/{id}/transitionsassetUnits.transition
Moves the asset lifecycle to another state through its transition RPC, which writes the transition ledger. Uses compare-and-set on `expected_state`; a disallowed transition returns a 422 refusal. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requiere la capacidad assets.write_off.approve.
- Alcances de OAuth: assets.
- Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
- Estados de error: 400, 401, 404, 409, 422, 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 asset unit. |
Cuerpo de la solicitud: AssetTransitionRequest
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| expected_state | string | Sí | The state the caller believes the row is in (compare-and-set).Restricciones: pattern ^[A-Z][A-Za-z]*( [A-Z][A-Za-z]*)*$ |
| to_state | string | Sí | Target state.Restricciones: pattern ^[A-Z][A-Za-z]*( [A-Z][A-Za-z]*)*$ |
| reason | string | No | Reason, required by some transitions.Restricciones: length 1 to any |
{
"expected_state": "Active",
"to_state": "In Review",
"reason": "Client approved the revised scope."
}Respuesta 200: AssetUnit
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the asset unit. |
| 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. |
| asset_class_id | string (uuid) | Sí | Identifier of the asset class. |
| asset_tag | string | Sí | Asset tag (a code that is ours).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| asset_state | "Proposed" | "Received" | "Available" | "Reserved" | "Deployed" | "In Maintenance" | "Damaged" | "Lost" | "Retired" | Sí | Asset lifecycle state. |
| condition_enum_id | string | null | Sí | Condition: a row of the canon Asset Condition enumeration.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| home_venue_id | string (uuid) | null | Sí | Identifier of the venue the unit returns to. |
{
"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",
"asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"asset_tag": "NWL-TR-0042",
"asset_state": "Available",
"condition_enum_id": "ENM-017",
"home_venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}Ejemplos de código
curl -X POST "$XOS_BASE_URL/asset-units/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/transitions" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"expected_state":"Active","to_state":"In Review","reason":"Client approved the revised scope."}'const { data } = await xos.assetUnits.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"expected_state": "Active",
"to_state": "In Review",
"reason": "Client approved the revised scope."
});response = xos.asset_units.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expected_state": "Active", "to_state": "In Review", "reason": "Client approved the revised scope."})xos asset-units transition 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expected_state":"Active","to_state":"In Review","reason":"Client approved the revised scope."}'