Skip to content

Create an asset damage

Assets module

POST/asset-damageassetDamageReports.create

A damage report for an asset unit. Creates an asset damage. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability assets.damage.write.
  • OAuth scopes: assets.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: AssetDamageCreate

assetDamageReports.create: AssetDamageCreate
FieldTypeRequiredDescription
asset_unit_idstring (uuid)YesIdentifier of the asset unit.
reported_atstring (date-time)NoWhen the damage was reported.
descriptionstringYesWhat is damaged.Constraints: 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.
{
  "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"
}

Response 201: AssetDamage

assetDamageReports.create: AssetDamage
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset damage.
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.
reported_atstring (date-time)YesWhen the damage was reported.
descriptionstringYesWhat is damaged.Constraints: length 1 to 20000
project_idstring (uuid) | nullYesIdentifier of the project during which the damage happened.
responsible_counterparty_idstring (uuid) | nullYesIdentifier 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"
}

Code samples

curl -X POST "$XOS_BASE_URL/asset-damage" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"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"}'
const { data } = await xos.assetDamageReports.create({
    "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"
  });
response = xos.asset_damage_reports.create({"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"})
xos asset-damage-reports create --data '{"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"}'