Saltar al contenido

Get an incident party

Módulo Safety

GET/incident-parties/{id}incidentParties.get

A person involved in an incident. Returns one incident party with its `ETag`. A incident party 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

incidentParties.get: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the incident party.
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: IncidentParty

incidentParties.get: IncidentParty
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the incident party.
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.
incident_idstring (uuid)SíIdentifier of the incident.
person_idstring (uuid) | nullSíIdentifier of the involved person.
descriptionstringSíRole in the incident, or a description of an unknown person.Restricciones: length 1 to 300
{
  "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",
  "incident_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Witness"
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/incident-parties/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.incidentParties.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.incident_parties.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos incident-parties get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f