Skip to content

Transition the requisition state

People module

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`.

  • Requires the capability people.requisition.write.
  • OAuth scopes: people.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

requisitions.transition: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the requisition.

Request body: RequisitionTransitionRequest

requisitions.transition: RequisitionTransitionRequest
FieldTypeRequiredDescription
expected_statestringYesThe state the caller believes the row is in (compare-and-set).Constraints: pattern ^[A-Z][A-Za-z]*( [A-Z][A-Za-z]*)*$
to_statestringYesTarget state.Constraints: pattern ^[A-Z][A-Za-z]*( [A-Z][A-Za-z]*)*$
reasonstringNoReason, required by some transitions.Constraints: length 1 to any
{
  "expected_state": "Approved",
  "to_state": "Filled",
  "reason": "Client approved the revised scope."
}

Response 200: Requisition

requisitions.transition: Requisition
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the requisition.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
project_idstring (uuid)YesIdentifier of the project.
role_codeRoleCodeYesWorkforce role code from `xpms.dim_role`, on URID grammar.Constraints: pattern ^[0-9]000\.[0-9]{2}\.[0-9]{2}$
requisition_state"Proposed" | "Approved" | "Rejected" | "Filled" | "Canceled"YesRequisition state.
scope_node_idstring (uuid) | nullYesIdentifier of the scope node of the same project.
budget_line_idstring (uuid) | nullYesIdentifier of the budget line the cost is charged to.
role_type"Crew" | "Contractor" | "Staff" | "Vendor" | "Artist" | "Artist Representative" | "Client" | "Sponsor" | nullYesExternal role type an opportunity published from the requisition seeks; null when filled internally.
worker_classificationstring | nullYesWorker classification, from xpms.worker_classification.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
pay_basisstring | nullYesPay basis; set with the arrangement.Constraints: length 1 to 300
arrangementstring | nullYesArrangement; set with the pay basis.Constraints: length 1 to 300
headcountintegerYesPeople requested.Constraints: range 1 to any
units_per_headnumber | nullYesPay basis units each person works, such as hours.
rate_minorinteger (int64) | nullYesRate per pay basis unit. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestringYesISO 4217 currency of the rate.Constraints: pattern ^[A-Z]{3}$
starts_onstring (date) | nullYesFirst day of the work.
ends_onstring (date) | nullYesLast day of the work.
justificationstringYesWhy the staff are needed.Constraints: length 1 to 2000
requested_bystring (uuid) | nullYesIdentifier 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"
}

Code samples

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."}'