Retrieve an asset by its ID

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.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
path Parameters
id
required
integer <int64> (CogniteInternalId) [ 1 .. 9007199254740991 ]

A server-generated ID for the object.

Responses
200

Response with a single asset.

400

The response for a bad request.

429

The response for too many requests (concurrency or rate throttling).

get/assets/{id}
Request samples
const assets = await client.assets.retrieve([{id: 123}, {externalId: 'abc'}]);
Response samples
application/json
{
  • "createdTime": 1730204346000,
  • "lastUpdatedTime": 1730204346000,
  • "rootId": 1,
  • "aggregates": {
    • "childCount": 0,
    • "depth": 0,
    • "path": [
      ]
    },
  • "parentId": 1,
  • "parentExternalId": "my.known.id",
  • "externalId": "my.known.id",
  • "name": "string",
  • "description": "string",
  • "dataSetId": 1,
  • "metadata": {
    • "property1": "string",
    • "property2": "string"
    },
  • "source": "string",
  • "labels": [
    • {
      }
    ],
  • "geoLocation": {
    • "type": "Feature",
    • "geometry": {
      },
    • "properties": { }
    },
  • "id": 1
}