Saltar al contenido

Create an incident party

Módulo Safety

POST/incident-partiesincidentParties.create

A person involved in an incident. Creates an incident party. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • 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, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: IncidentPartyCreate

incidentParties.create: IncidentPartyCreate
CampoTipoObligatorioDescripción
incident_idstring (uuid)SíIdentifier of the incident.
person_idstring (uuid) | nullNoIdentifier of the involved person.
descriptionstringSíRole in the incident, or a description of an unknown person.Restricciones: length 1 to 300
{
  "incident_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "description": "Witness"
}

Respuesta 201: IncidentParty

incidentParties.create: 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 POST "$XOS_BASE_URL/incident-parties" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"incident_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Witness"}'
const { data } = await xos.incidentParties.create({
    "incident_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "description": "Witness"
  });
response = xos.incident_parties.create({"incident_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "description": "Witness"})
xos incident-parties create --data '{"incident_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","description":"Witness"}'