List simulator routines

async AsyncCogniteClient.simulators.routines.list(
limit: int = 25,
model_external_ids: Sequence[str] | None = None,
simulator_integration_external_ids: Sequence[str] | None = None,
kind: Literal['long'] | None = None,
sort: PropertySort | None = None,
) → SimulatorRoutineList

Filter simulator routines

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

Parameters:

  • limit (int) – Maximum number of results to return. Defaults to 25. Set to -1, float(“inf”) or None to return all items.

  • model_external_ids (Sequence[str] | None) – Filter on model external ids.

  • simulator_integration_external_ids (Sequence[str] | None) – Filter on simulator integration external ids.

  • kind (Literal['long'] | None) – Filter on routine kind.

  • sort (PropertySort | None) – The criteria to sort by.

Returns:

List of simulator routines

Return type:

SimulatorRoutineList

Examples

List simulator routines:
>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.simulators.routines.list(limit=10)
Iterate over simulator routines, one-by-one:
>>> for routine in client.simulators.routines():
...     routine  # do something with the simulator routine
Specify filter and sort order:
>>> from cognite.client.data_classes.simulators.filters import PropertySort
>>> res = client.simulators.routines.list(
...     simulator_integration_external_ids=["integration_ext_id"],
...     sort=PropertySort(property="createdTime", order="desc"),
... )
Filter on routine kind:
>>> res = client.simulators.routines.list(kind="long")