Saltar al contenido

Transition the incident state

Módulo Safety

POST/incidents/{id}/transitionsincidents.transition

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

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

Cuerpo de la solicitud: IncidentTransitionRequest

incidents.transition: IncidentTransitionRequest
CampoTipoObligatorioDescripción
expected_state"Reported" | "Dispatched" | "Contained"SíThe state the caller believes the row is in (compare-and-set).
to_state"Reported" | "Dispatched" | "Contained"SíTarget state.
reasonstringNoReason, required by some transitions.Restricciones: length 1 to any
{
  "expected_state": "Reported",
  "to_state": "Dispatched",
  "reason": "Client approved the revised scope."
}

Respuesta 200: Incident

incidents.transition: Incident
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the incident.
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.
titlestringSíShort description.Restricciones: length 1 to 300
occurred_atstring (date-time)SíWhen it happened.
zone_idstring (uuid) | nullSíIdentifier of the zone.
latitudenumber | nullSíWGS 84 latitude.Restricciones: range -90 to 90
longitudenumber | nullSíWGS 84 longitude.Restricciones: range -180 to 180
severity_enum_idstringSíSeverity: a row of the canon Incident Severity enumeration.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
incident_numberintegerSíNumber from the project's display key sequence.Restricciones: range 1 to any
incident_state"Reported" | "Dispatched" | "Contained" | "Closed"SíIncident state.
reported_bystring (uuid) | nullSíIdentifier of the reporter, from the session.
closed_signed_off_bystring (uuid) | nullSíIdentifier of the person who signed off the closure.
accuracy_mnumber | nullSíHorizontal accuracy of the location in meters.
device_reported_atstring (date-time) | nullSíWhen the reporter filed it on the device, for a report queued offline.
closed_atstring (date-time) | nullSíWhen the incident moved to Closed, from its transition ledger.
{
  "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",
  "title": "Guest Fall Near North Bar",
  "occurred_at": "2026-10-08T14:30:00Z",
  "zone_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "latitude": 25.7617,
  "longitude": -80.1918,
  "severity_enum_id": "ENM-097",
  "incident_number": 142,
  "incident_state": "Reported",
  "reported_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "closed_signed_off_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "accuracy_m": 8,
  "device_reported_at": "2026-10-08T14:30:00Z",
  "closed_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

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