Skip to content

Update an inspection result

Safety module

PATCH/inspection-results/{id}inspectionResults.update

Pass or fail for one inspection item. 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.

  • Requires the capability safety.inspection.write.
  • OAuth scopes: safety.
  • Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
  • Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.

Path and query parameters

inspectionResults.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the inspection result.

Request body: InspectionResultUpdate

inspectionResults.update: InspectionResultUpdate
FieldTypeRequiredDescription
notestring | nullNoNotes.Constraints: length 1 to 20000
result_enum_idstringNoRow of the canon Inspection Result enumeration, for example ENM-084 (Failed).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
photo_uristring | nullNoObject name of the finding's photo in the field-media bucket.Constraints: length 1 to 500
{
  "note": "Left rail tightened on site.",
  "result_enum_id": "ENM-084",
  "photo_uri": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/inspections/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/rail.jpg"
}

Response 200: InspectionResult

inspectionResults.update: InspectionResult
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the inspection result.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
inspection_idstring (uuid)YesIdentifier of the inspection.
inspection_item_idstring (uuid)YesIdentifier of the inspection item.
notestring | nullYesNotes.Constraints: length 1 to 20000
result_enum_idstringYesRow of the canon Inspection Result enumeration, for example ENM-084 (Failed).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
photo_uristring | nullYesObject name of the finding's photo in the field-media bucket.Constraints: length 1 to 500
project_idstring (uuid)YesIdentifier of the project, from the inspection.
{
  "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_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "inspection_item_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "note": "Left rail tightened on site.",
  "result_enum_id": "ENM-084",
  "photo_uri": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/inspections/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/rail.jpg",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/inspection-results/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 '{"note":"Left rail tightened on site.","result_enum_id":"ENM-084","photo_uri":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/inspections/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/rail.jpg"}'
const { data, etag } = await xos.inspectionResults.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "note": "Left rail tightened on site.",
    "result_enum_id": "ENM-084",
    "photo_uri": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/inspections/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/rail.jpg"
  }, { ifMatch: etag });
response = xos.inspection_results.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"note": "Left rail tightened on site.", "result_enum_id": "ENM-084", "photo_uri": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/inspections/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/rail.jpg"}, if_match=etag)
xos inspection-results update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"note":"Left rail tightened on site.","result_enum_id":"ENM-084","photo_uri":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/inspections/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/rail.jpg"}' --if-match auto