GET

/assets/{assetId}/assetRelationships#traversalType

http://iotsitewise.{region}.amazonaws.com/assets/{assetId}/assetRelationships#traversalType

Retrieves a paginated list of asset relationships for an asset. You can use this operation to identify an asset's root asset and all associated assets between that asset and its root.

Access Token Required: API Key

Path Parameters

assetIdstringrequired

The ID of the asset.

Query Params

traversalTypestringrequired

<p>The type of traversal to use to identify asset relationships. Choose the following option:</p> <ul> <li> <p> <code>PATH_TO_ROOT</code> – Identify the asset's parent assets up to the root asset. The asset that you specify in <code>assetId</code> is the first result in the list of <code>assetRelationshipSummaries</code>, and the root asset is the last result.</p> </li> </ul>

Allowed:

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.

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}/assetRelationships#traversalType' \
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}