const assets = await client.assets.retrieve([{id: 123}, {externalId: 'abc'}]);{
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"rootId": 4503599627370496,
"name": "<string>",
"id": 4503599627370496,
"aggregates": {
"childCount": 1,
"depth": 1,
"path": [
{
"id": 4503599627370496
}
]
},
"parentId": 4503599627370496,
"parentExternalId": "my.known.id",
"externalId": "my.known.id",
"description": "<string>",
"dataSetId": 4503599627370496,
"metadata": {},
"source": "<string>",
"labels": [
{
"externalId": "my.known.id"
}
],
"geoLocation": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
123
]
},
"properties": {}
}
}Retrieve an asset by its ID
Required capabilities:
assetsAcl:READ
Retrieve an asset by its internal ID. If you want to retrieve assets by externalIds, use Retrieve assets instead.
Request throttling
This endpoint is a subject of the new throttling schema (limited request rate and concurrency). Please check Assets resource description for more information.
const assets = await client.assets.retrieve([{id: 123}, {externalId: 'abc'}]);{
"createdTime": 1730204346000,
"lastUpdatedTime": 1730204346000,
"rootId": 4503599627370496,
"name": "<string>",
"id": 4503599627370496,
"aggregates": {
"childCount": 1,
"depth": 1,
"path": [
{
"id": 4503599627370496
}
]
},
"parentId": 4503599627370496,
"parentExternalId": "my.known.id",
"externalId": "my.known.id",
"description": "<string>",
"dataSetId": 4503599627370496,
"metadata": {},
"source": "<string>",
"labels": [
{
"externalId": "my.known.id"
}
],
"geoLocation": {
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
123
]
},
"properties": {}
}
}Authorizations
Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.
Path Parameters
A server-generated ID for the object.
1 <= x <= 9007199254740991Response
Response with a single asset.
A representation of a physical asset, for example a factory or a piece of equipment.
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.
x >= 01730204346000
The ID of the root asset. The root asset is the asset spanning the entire asset hierarchy that this asset belongs to.
1 <= x <= 9007199254740991The name of the asset.
1 - 140A server-generated ID for the object.
1 <= x <= 9007199254740991Aggregated metrics of the asset.
Show child attributes
Show child attributes
The parent node's ID used to specify parent-child relationship.
You should not use this field in combination with the parentExternalId field.
1 <= x <= 9007199254740991The parent node's external ID used to specify the parent-child relationship. When specifying this field, the API will resolve the external ID into an internal ID and use the internal ID to store the parent-child relation. As a result, a later change to update the parent's external ID will not affect this parent-child relationship as it is based on internal ID.
You should not use this field in combination with the parentId field.
255"my.known.id"
The external ID provided by the client. Must be unique for the resource type.
255"my.known.id"
The description of the asset.
500The id of the dataset this asset belongs to.
1 <= x <= 9007199254740991Custom, application specific metadata. String key -> String value. Limits: Maximum length of key is 128 bytes, value 10240 bytes, up to 256 key-value pairs, of total size at most 10240.
Show child attributes
Show child attributes
The source of the asset.
128A list of the labels associated with this resource item.
10Show child attributes
Show child attributes
Geographic metadata.
Show child attributes
Show child attributes
Was this page helpful?