Transition the work order state

Módulo Work

POST/work-orders/{id}/transitionsworkOrders.transition

Moves the work order 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 work.work_order.write.
Alcances de OAuth: work.
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

workOrders.transition: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the work order.

Cuerpo de la solicitud: WorkOrderTransitionRequest

workOrders.transition: WorkOrderTransitionRequest
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": "Proposed",
  "to_state": "Active",
  "reason": "Client approved the revised scope."
}

Respuesta 200: WorkOrder

workOrders.transition: WorkOrder
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the work order.
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.
project_id	string (uuid)	Sí	Identifier of the project.
record_id	string (uuid) \| null	Sí	Identifier of the record the work order fulfills.
title	string	Sí	Work order title.Restricciones: length 1 to 300
urid	UridAtAnyGrain	Sí	URID at discipline grain (`DDDD.DD`) or category grain (`DDDD.DD.DD`), as GL dimension 2 allows.Restricciones: pattern ^[0-9]000(\.[0-9]{2}){1,2}$
work_order_state	string	Sí	Work order state. A Title Case value from the lifecycle's database enum.Restricciones: pattern ^[A-Z0-9][A-Za-z0-9&'/.()-]( [A-Za-z0-9&'/.()-]+)$
due_at	string (date-time) \| null	Sí	When the work is due.
budget_minor	integer (int64) \| null	Sí	Budget for the work. Integer minor units of the resource currency; null means unpriced, never zero.
currency	string	Sí	ISO 4217 currency code of every money field.Restricciones: pattern ^[A-Z]{3}$
work_order_number	integer	Sí	Sequence number within the project; the display key is {project_key}-WO-{number}.Restricciones: range 1 to any
location_text	string \| null	Sí	Where the work happens, in words, when no zone says it.Restricciones: length 1 to 300
scope_of_work	string \| null	Sí	The scope bidders price, in sentence case.Restricciones: length 1 to 20000
scheduled_starts_at	string (date-time) \| null	Sí	Planned start.
estimated_hours	number \| null	Sí	Estimated labor hours; null when unestimated.

{
  "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",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "title": "Fabricate Bar Fascia",
  "urid": "4000.01",
  "work_order_state": "Proposed",
  "due_at": "2026-10-08T14:30:00Z",
  "budget_minor": 850000,
  "currency": "USD",
  "work_order_number": 12,
  "location_text": "Main stage, stage left wing.",
  "scope_of_work": "Supply and hang 24 moving lights.",
  "scheduled_starts_at": "2026-10-08T14:30:00Z",
  "estimated_hours": 16
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/work-orders/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/transitions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"expected_state":"Proposed","to_state":"Active","reason":"Client approved the revised scope."}'

const { data } = await xos.workOrders.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "expected_state": "Proposed",
    "to_state": "Active",
    "reason": "Client approved the revised scope."
  });

response = xos.work_orders.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expected_state": "Proposed", "to_state": "Active", "reason": "Client approved the revised scope."})

xos work-orders transition 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expected_state":"Proposed","to_state":"Active","reason":"Client approved the revised scope."}'