Retrieve an asset subtree

async AsyncCogniteClient.assets.retrieve_subtree(
id: int | None = None,
external_id: str | None = None,
depth: int | None = None,
) AssetList

Retrieve the subtree for this asset up to a specified depth.

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:

AssetList