Saltar al contenido

Update an inspection item

Módulo Safety

PATCH/inspection-items/{id}inspectionItems.update

An item of an inspection template. 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_template.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

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

Cuerpo de la solicitud: InspectionItemUpdate

inspectionItems.update: InspectionItemUpdate
CampoTipoObligatorioDescripción
positionintegerNoItem order.Restricciones: range 1 to any
promptstringNoWhat to check.Restricciones: length 1 to 300
is_criticalbooleanNoWhether a failure of this item stops use.
{
  "position": 1,
  "prompt": "Guardrails secured on all stage edges",
  "is_critical": true
}

Respuesta 200: InspectionItem

inspectionItems.update: InspectionItem
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the inspection item.
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.
inspection_template_idstring (uuid)SíIdentifier of the inspection template.
positionintegerSíItem order.Restricciones: range 1 to any
promptstringSíWhat to check.Restricciones: length 1 to 300
is_criticalbooleanSíWhether a failure of this item stops use.
{
  "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",
  "inspection_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "prompt": "Guardrails secured on all stage edges",
  "is_critical": true
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/inspection-items/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 '{"position":1,"prompt":"Guardrails secured on all stage edges","is_critical":true}'
const { data, etag } = await xos.inspectionItems.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "position": 1,
    "prompt": "Guardrails secured on all stage edges",
    "is_critical": true
  }, { ifMatch: etag });
response = xos.inspection_items.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"position": 1, "prompt": "Guardrails secured on all stage edges", "is_critical": True}, if_match=etag)
xos inspection-items update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"position":1,"prompt":"Guardrails secured on all stage edges","is_critical":true}' --if-match auto