List simulator integrations

async AsyncCogniteClient.simulators.integrations.list(

limit: int | None = 25,

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

active: bool | None = None,

) → SimulatorIntegrationList

Filter simulator integrations

Retrieves a list of simulator integrations that match the given criteria.

Parameters:

• limit (int | None) – The maximum number of simulator integrations to return, pass None to return all.

• simulator_external_ids (str | SequenceNotStr[str] | None) – Filter on simulator external ids.

• active (bool | None) – Filter on active status of the simulator integration.

Returns:

List of simulator integrations

Return type:

SimulatorIntegrationList

Examples

List a few simulator integrations:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.simulators.integrations.list(limit=10)

Iterate over simulator integrations, one-by-one:

>>> for integration in client.simulators.integrations():
...     integration  # do something with the simulator integration

Filter simulator integrations by simulator external ids and active status:

>>> res = client.simulators.integrations.list(
...     simulator_external_ids=["sim1", "sim2"],
...     active=True,
... )