v15
latestOpenAPI 3.1.02026-07-1295183803.5 KBCreate an Asset
Query parameters
A key is a unique identifier that is required to authenticate a request to the API.
Request body
Set a unique ID for the new asset. If not provided, an ID will be automatically generated in UUID format. A valid custom_id can contain letters, numbers, "-", & "_" only.
Please note that the ID of an asset can not be changed once it is created.
Description for the asset.
Any valid json object data. Can be used to save customized data. Max size is 65kb.
Name of the asset. Use this field to assign a meaningful, custom name to the asset being created.
This parameter will be deprecated soon! Please use the attributes parameter to add labels or markers for the asset.
Tags of the asset. tags can be used for filtering assets in operations like Get Asset List and asset Search methods. They can also be used for monitoring of assets using the Monitor methods after linking tags and asset.
Valid tags are strings consisting of alphanumeric characters (A-Z, a-z, 0-9) along with the underscore ('_') and hyphen ('-') symbols.
attributes can be used to store custom information about an asset in key:value format. Use attributes to add any useful information or context to your assets like the vehicle type, shift timing etc. Moreover, these attributes can be used to filter assets in Search, Monitor, and Get Asset List queries.
Please note that the maximum number of key:value pairs that can be added to an attributes object is 100. Also, the overall size of attributes object should not exceed 65kb.
Response
OK
A string indicating the state of the response. On successful responses, the value will be Ok. Indicative error messages are returned for different errors. See the API Error Codes section below for more information.
Displays the error message in case of a failed request. If the request is successful, this field is not present in the response.