damage

November 12, 2025 · View on GitHub

A damage of the asset.

Type: object

semantics [{'transmodel': 'none'}]


Properties overview

PropertyTypeRequiredDescription
assetComponentenum (FRONT, REAR, LEFT, RIGHT, TOP, ...)Part/Component of the asset affected. If OTHER is specified the description n...
descriptionlongStringDescription of the damage.
picturesarray[url]URL where pictures of the damage can be accessed. Any special characters in t...

Detailed Properties

  • assetComponent (enum (FRONT, REAR, LEFT, RIGHT, TOP, ...)) - required
    Part/Component of the asset affected. If OTHER is specified the description needs to provide more detail as to what part/component is affected.

  • description (longString) - required
    Description of the damage.

  • pictures (array[url]) - optional
    URL where pictures of the damage can be accessed. Any special characters in the URL must be correctly escaped.

Additional Properties

❌ No additional properties are allowed.

Example

{
  "assetComponent": "FRONT",
  "description": "example-string",
  "pictures": [
    "https://example.com",
    "https://example.com"
  ]
}