Skip to content

Transition the asset state

Assets module

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

  • Requires the capability assets.write_off.approve.
  • OAuth scopes: assets.
  • 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

assetUnits.transition: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset unit.

Request body: AssetTransitionRequest

assetUnits.transition: AssetTransitionRequest
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": "Active",
  "to_state": "In Review",
  "reason": "Client approved the revised scope."
}

Response 200: AssetUnit

assetUnits.transition: AssetUnit
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset unit.
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.
asset_class_idstring (uuid)YesIdentifier of the asset class.
asset_tagstringYesAsset tag (a code that is ours).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
asset_state"Proposed" | "Received" | "Available" | "Reserved" | "Deployed" | "In Maintenance" | "Damaged" | "Lost" | "Retired"YesAsset lifecycle state.
condition_enum_idstring | nullYesCondition: a row of the canon Asset Condition enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
home_venue_idstring (uuid) | nullYesIdentifier 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"
}

Code samples

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