Retrieve an asset subtree
- async AsyncCogniteClient.assets.retrieve_subtree(
- id: int | None = None,
- external_id: str | None = None,
- depth: int | None = None,
Retrieve the subtree for this asset up to a specified depth.
Deprecated since version 8.23.0: The Assets API is deprecated and is scheduled for removal on 2027-12-31. Move asset hierarchies to CogniteAsset in the core data model. See https://docs.cognite.com/cdf/deprecated for details and migration guidance.
- Parameters:
id (int | None) – Id of the root asset in the subtree.
external_id (str | None) – External id of the root asset in the subtree.
depth (int | None) – Retrieve assets up to this depth below the root asset in the subtree. Omit to get the entire subtree.
- Returns:
The requested assets or empty AssetList if asset does not exist.
- Return type: