Set asset description
PATCH /asset/<assetId>/description
Description
Set the asset description. Success (204) is also returned when the asset description has not changed.
Path parameters
| Param | Description |
|---|---|
assetId |
Asset Id. |
Query parameters
none
Body
| Param | Type | Required | Description |
|---|---|---|---|
description |
string | Yes | Asset description. |
Return codes
| Error code | Reason |
|---|---|
204 |
Success. |
400 |
Invalid body. |
401 |
Invalid or missing token. |
403 |
Insufficient permissions (required: API+ASSET_MANAGEMENT). |
404 |
Asset not found. |
Example
Curl request:
curl \
-X PATCH 'https://api.infrasonar.com/asset/123/description' \
-H 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
-H 'Content-Type: application/json' \
--data-raw '{
"description": "This is cool asset!"
}'