Saltar al contenido

Update an inspection

Módulo Safety

PATCH/inspections/{id}inspections.update

An inspection performed from a template, with sign-off. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

  • Requiere la capacidad safety.inspection.write.
  • Alcances de OAuth: safety.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

inspections.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the inspection.

Cuerpo de la solicitud: InspectionUpdate

inspections.update: InspectionUpdate
CampoTipoObligatorioDescripción
record_idstring (uuid) | nullNoIdentifier of the Inspection record of the same project.
uridUrid | nullNo
{
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 200: Inspection

inspections.update: Inspection
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the inspection.
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.
inspection_template_idstring (uuid)SíIdentifier of the inspection template.
inspector_person_idstring (uuid) | nullSíIdentifier of the inspector, from the session.
signed_off_bystring (uuid) | nullSíIdentifier of the person who signed off.
signed_off_atstring (date-time) | nullSíWhen it was signed off.
record_idstring (uuid) | nullSíIdentifier of the Inspection record of the same project.
inspected_atstring (date-time)SíWhen the inspection took place.
uridUrid | nullSí
{
  "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",
  "inspection_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "inspector_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "signed_off_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "signed_off_at": "2026-10-08T14:30:00Z",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "inspected_at": "2026-10-08T14:30:00Z",
  "urid": "4000.01.01"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/inspections/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H 'If-Match: W/"etag-from-your-last-read"' \
  -H "Content-Type: application/json" \
  -d '{"record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data, etag } = await xos.inspections.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  }, { ifMatch: etag });
response = xos.inspections.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)
xos inspections update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto