Retrieve simulator models

async AsyncCogniteClient.simulators.models.retrieve(

*,

ids: int | Sequence[int] | None = None,

external_ids: str | SequenceNotStr[str] | None = None,

) → SimulatorModel | SimulatorModelList | None

Retrieve simulator models

Retrieve one or more simulator models by ID(s) or external ID(s).

Parameters:

• ids (int | Sequence[int] | None) – The id of the simulator model(s).

• external_ids (str | SequenceNotStr[str] | None) – The external id of the simulator model(s).

Returns:

Requested simulator model(s)

Return type:

SimulatorModel | SimulatorModelList | None

Examples

Get simulator model by id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.simulators.models.retrieve(ids=1)

Get simulator model by external id:

>>> res = client.simulators.models.retrieve(external_ids="model_external_id")

Get multiple simulator models by ids:

>>> res = client.simulators.models.retrieve(ids=[1, 2])

Get multiple simulator models by external ids:

>>> res = client.simulators.models.retrieve(
...     external_ids=["model_external_id", "model_external_id2"]
... )