GET

/assets/{assetId}/properties

http://iotsitewise.{region}.amazonaws.com/assets/{assetId}/properties

Retrieves a paginated list of properties associated with an asset. If you update properties associated with the model before you finish listing all the properties, you need to start all over again.

Access Token Required: API Key

Path Parameters

assetIdstringrequired

The ID of the asset.

Query Params

nextTokenstring

The token to be used for the next set of paginated results.

maxResultsinteger

The maximum number of results to return for each paginated request. If not specified, the default value is 50.

filterstring

Filters the requested list of asset properties. You can choose one of the following options: <ul> <li> <code>ALL</code> – The list includes all asset properties for a given asset model ID. </li> <li> <code>BASE</code> – The list includes only base asset properties for a given asset model ID. </li> </ul> Default: <code>BASE</code>

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://iotsitewise.{region}.amazonaws.com/assets/{assetId}/properties' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}