Retrieve containers by id(s)

async AsyncCogniteClient.data_modeling.containers.retrieve(

ids: ContainerId | tuple[str, str] | Sequence[ContainerId | tuple[str, str]],

) → Container | ContainerList | None

Retrieve one or more container by id(s).

Parameters:

ids (ContainerIdentifier | Sequence[ContainerIdentifier]) – Identifier for container(s).

Returns:

Requested container or None if it does not exist.

Return type:

Container | ContainerList | None

Examples

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.data_modeling.containers.retrieve(("mySpace", "myContainer"))

Fetch using the ContainerId:

>>> from cognite.client.data_classes.data_modeling import ContainerId
>>> res = client.data_modeling.containers.retrieve(
...     ContainerId(space="mySpace", external_id="myContainer")
... )