Saltar al contenido

Update an asset damage

Módulo Assets

PATCH/asset-damage/{id}assetDamageReports.update

A damage report 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.

  • Requiere la capacidad assets.damage.write.
  • Alcances de OAuth: assets.
  • 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

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

Cuerpo de la solicitud: AssetDamageUpdate

assetDamageReports.update: AssetDamageUpdate
CampoTipoObligatorioDescripción
reported_atstring (date-time)NoWhen the damage was reported.
descriptionstringNoWhat is damaged.Restricciones: length 1 to 20000
project_idstring (uuid) | nullNoIdentifier of the project during which the damage happened.
responsible_counterparty_idstring (uuid) | nullNoIdentifier of the counterparty responsible.
{
  "reported_at": "2026-10-08T14:30:00Z",
  "description": "Bent chord on one end.",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "responsible_counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Respuesta 200: AssetDamage

assetDamageReports.update: AssetDamage
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the asset damage.
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.
asset_unit_idstring (uuid)SíIdentifier of the asset unit.
reported_atstring (date-time)SíWhen the damage was reported.
descriptionstringSíWhat is damaged.Restricciones: length 1 to 20000
project_idstring (uuid) | nullSíIdentifier of the project during which the damage happened.
responsible_counterparty_idstring (uuid) | nullSíIdentifier of the counterparty responsible.
{
  "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",
  "reported_at": "2026-10-08T14:30:00Z",
  "description": "Bent chord on one end.",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "responsible_counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X PATCH "$XOS_BASE_URL/asset-damage/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 '{"reported_at":"2026-10-08T14:30:00Z","description":"Bent chord on one end.","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","responsible_counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}'
const { data, etag } = await xos.assetDamageReports.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "reported_at": "2026-10-08T14:30:00Z",
    "description": "Bent chord on one end.",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "responsible_counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
  }, { ifMatch: etag });
response = xos.asset_damage_reports.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"reported_at": "2026-10-08T14:30:00Z", "description": "Bent chord on one end.", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "responsible_counterparty_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}, if_match=etag)
xos asset-damage-reports update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"reported_at":"2026-10-08T14:30:00Z","description":"Bent chord on one end.","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","responsible_counterparty_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"}' --if-match auto