Retrieve data models by id(s)

async AsyncCogniteClient.data_modeling.data_models.retrieve(
ids: DataModelId | tuple[str, str] | tuple[str, str, str] | Sequence[DataModelId | tuple[str, str] | tuple[str, str, str]],
inline_views: bool = False,
) → DataModelList[ViewId] | DataModelList[View]

Retrieve data_model(s) by id(s).

Parameters:

  • ids (DataModelIdentifier | Sequence[DataModelIdentifier]) – Data Model identifier(s).

  • inline_views (bool) – Whether to expand the referenced views inline in the returned result.

Returns:

Requested data model(s) or empty if none exist.

Return type:

DataModelList[ViewId] | DataModelList[View]

Examples

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