Saltar al contenido

Transition the requisition state

Módulo People

POST/requisitions/{id}/transitionsrequisitions.transition

Moves the requisition 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 people.requisition.write.
  • Alcances de OAuth: people.
  • 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

requisitions.transition: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the requisition.

Cuerpo de la solicitud: RequisitionTransitionRequest

requisitions.transition: RequisitionTransitionRequest
CampoTipoObligatorioDescripción
expected_statestringSí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_statestringSíTarget state.Restricciones: pattern ^[A-Z][A-Za-z]*( [A-Z][A-Za-z]*)*$
reasonstringNoReason, required by some transitions.Restricciones: length 1 to any
{
  "expected_state": "Approved",
  "to_state": "Filled",
  "reason": "Client approved the revised scope."
}

Respuesta 200: Requisition

requisitions.transition: Requisition
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the requisition.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_idstring (uuid)SíIdentifier of the project.
role_codeRoleCodeSíWorkforce role code from `xpms.dim_role`, on URID grammar.Restricciones: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
requisition_state"Proposed" | "Approved" | "Rejected" | "Filled" | "Canceled"SíRequisition state.
scope_node_idstring (uuid) | nullSíIdentifier of the scope node of the same project.
budget_line_idstring (uuid) | nullSíIdentifier of the budget line the cost is charged to.
role_type"Crew" | "Contractor" | "Staff" | "Vendor" | "Artist" | "Artist Representative" | "Client" | "Sponsor" | nullSíExternal role type an opportunity published from the requisition seeks; null when filled internally.
worker_classificationstring | nullSíWorker classification, from xpms.worker_classification.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
pay_basisstring | nullSíPay basis; set with the arrangement.Restricciones: length 1 to 300
arrangementstring | nullSíArrangement; set with the pay basis.Restricciones: length 1 to 300
headcountintegerSíPeople requested.Restricciones: range 1 to any
units_per_headnumber | nullSíPay basis units each person works, such as hours.
rate_minorinteger (int64) | nullSíRate per pay basis unit. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringSíISO 4217 currency of the rate.Restricciones: pattern ^[A-Z]{3}$
starts_onstring (date) | nullSíFirst day of the work.
ends_onstring (date) | nullSíLast day of the work.
justificationstringSíWhy the staff are needed.Restricciones: length 1 to 2000
requested_bystring (uuid) | nullSíIdentifier of the person who requested; they cannot approve it.
{
  "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",
  "role_code": "5000.50.01",
  "requisition_state": "Proposed",
  "scope_node_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "budget_line_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "role_type": "Crew",
  "worker_classification": "EMPLOYEE",
  "pay_basis": "Hourly",
  "arrangement": "Per Engagement",
  "headcount": 12,
  "units_per_head": 10,
  "rate_minor": 4500,
  "currency_code": "USD",
  "starts_on": "2026-10-08",
  "ends_on": "2026-10-08",
  "justification": "Second stage added for the festival.",
  "requested_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/requisitions/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/transitions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"expected_state":"Approved","to_state":"Filled","reason":"Client approved the revised scope."}'
const { data } = await xos.requisitions.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "expected_state": "Approved",
    "to_state": "Filled",
    "reason": "Client approved the revised scope."
  });
response = xos.requisitions.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expected_state": "Approved", "to_state": "Filled", "reason": "Client approved the revised scope."})
xos requisitions transition 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expected_state":"Approved","to_state":"Filled","reason":"Client approved the revised scope."}'