GET /asset_model/properties

Get a list of available asset property types that can be used.

Get a list of available asset property types that can be used or applied against the /asset_model/assets endpoint.

Table 1. GET /asset_model/properties resource details
MIME Type

application/json

Table 2. GET /asset_model/properties request parameter details
Parameter Type Optionality Data Type MIME Type Description

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

Table 3. GET /asset_model/properties response codes
HTTP Response Code Unique Code Description

200

The request to retrieve the list of asset property types completed successfully.

500

1020

An error occurred while trying to retrieve the list of asset property types.

Response Description

List of asset properties. Per asset property type: id and name that make up this asset property type.

Response Sample


[
    {
        "custom": true,
        "data_type": "String",
        "display": true,
        "id": 42,
        "name": "String",
        "state": 42
    }
]