Saltar al contenido

Get an incident

Módulo Safety

GET/incidents/{id}incidents.get

An incident with dispatch. A critical incident cannot be relabeled and closed in one statement; closing requires sign-off. Returns one incident with its `ETag`. A incident the caller may not see returns 404.

  • Requiere la capacidad safety.incident.read.
  • Alcances de OAuth: safety.
  • Estados de error: 400, 401, 404, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

incidents.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the incident.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Respuesta 200: Incident

incidents.get: 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 GET "$XOS_BASE_URL/incidents/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.incidents.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.incidents.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos incidents get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f