Skip to content

Update an asset maintenance

Assets module

PATCH/asset-maintenance/{id}assetMaintenanceEvents.update

A maintenance event for an asset unit. 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 assets.maintenance.write.
  • OAuth scopes: assets.
  • 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

assetMaintenanceEvents.update: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset maintenance.

Request body: AssetMaintenanceUpdate

assetMaintenanceEvents.update: AssetMaintenanceUpdate
FieldTypeRequiredDescription
performed_onstring (date)NoWhen the maintenance was done.
descriptionstringNoWhat was done.Constraints: length 1 to 20000
cost_minorinteger (int64) | nullNoMaintenance cost. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullNoISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
{
  "performed_on": "2026-10-08",
  "description": "Replaced the spigots.",
  "cost_minor": 12000,
  "currency_code": "USD"
}

Response 200: AssetMaintenance

assetMaintenanceEvents.update: AssetMaintenance
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset maintenance.
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.
asset_unit_idstring (uuid)YesIdentifier of the asset unit.
performed_onstring (date)YesWhen the maintenance was done.
descriptionstringYesWhat was done.Constraints: length 1 to 20000
cost_minorinteger (int64) | nullYesMaintenance cost. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullYesISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
{
  "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",
  "asset_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "performed_on": "2026-10-08",
  "description": "Replaced the spigots.",
  "cost_minor": 12000,
  "currency_code": "USD"
}

Code samples

curl -X PATCH "$XOS_BASE_URL/asset-maintenance/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 '{"performed_on":"2026-10-08","description":"Replaced the spigots.","cost_minor":12000,"currency_code":"USD"}'
const { data, etag } = await xos.assetMaintenanceEvents.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "performed_on": "2026-10-08",
    "description": "Replaced the spigots.",
    "cost_minor": 12000,
    "currency_code": "USD"
  }, { ifMatch: etag });
response = xos.asset_maintenance_events.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"performed_on": "2026-10-08", "description": "Replaced the spigots.", "cost_minor": 12000, "currency_code": "USD"}, if_match=etag)
xos asset-maintenance-events update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"performed_on":"2026-10-08","description":"Replaced the spigots.","cost_minor":12000,"currency_code":"USD"}' --if-match auto