asset

Get an asset by its ID or Tag.

Changed on
get/assets/{id}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/assets/{id}
  • Auth: none declared

Path parameters

Requested asset ID

Response

Success

aliasstring nullable

An optional alias for this asset. This is purely for convenience in searching for and identifying multiple instances of similar assets.

bundlestring uuid nullable

An optional bundle that this asset is within, as asset bundle identifier.

idstring uuid required

The unique identifier for this asset. This property is immutable.

notesstring nullable

An optional field for miscellaneous notes about the asset.

tagstring required

The asset tag attached to this asset.

typestring uuid required

The type of this asset, as an asset type identifier. This property is immutable.

Changes