List simulation runs

async AsyncCogniteClient.simulators.runs.list(
limit: int | None = 25,
status: str | None = None,
run_type: str | None = None,
model_external_ids: SequenceNotStr[str] | None = None,
simulator_integration_external_ids: SequenceNotStr[str] | None = None,
simulator_external_ids: SequenceNotStr[str] | None = None,
routine_external_ids: SequenceNotStr[str] | None = None,
routine_revision_external_ids: SequenceNotStr[str] | None = None,
model_revision_external_ids: SequenceNotStr[str] | None = None,
created_time: TimestampRange | None = None,
simulation_time: TimestampRange | None = None,
sort: SimulationRunsSort | None = None,
) → SimulationRunList

Filter simulation runs

Retrieves a list of simulation runs that match the given criteria.

Parameters:

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

  • status (str | None) – Filter by simulation run status

  • run_type (str | None) – Filter by simulation run type

  • model_external_ids (SequenceNotStr[str] | None) – Filter by simulator model external ids

  • simulator_integration_external_ids (SequenceNotStr[str] | None) – Filter by simulator integration external ids

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

  • routine_external_ids (SequenceNotStr[str] | None) – Filter by routine external ids

  • routine_revision_external_ids (SequenceNotStr[str] | None) – Filter by routine revision external ids

  • model_revision_external_ids (SequenceNotStr[str] | None) – Filter by model revision external ids

  • created_time (TimestampRange | None) – Filter by created time

  • simulation_time (TimestampRange | None) – Filter by simulation time

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

Returns:

List of simulation runs

Return type:

SimulationRunList

Examples

List simulation runs:
>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> res = client.simulators.runs.list()
Iterate over simulation runs, one-by-one:
>>> for run in client.simulators.runs():
...     run  # do something with the simulation run
Filter runs by status and simulator external ids:
>>> res = client.simulators.runs.list(
...     simulator_external_ids=["PROSPER", "DWSIM"], status="success"
... )
Filter runs by time ranges:
>>> from cognite.client.data_classes.shared import TimestampRange
>>> res = client.simulators.runs.list(
...     created_time=TimestampRange(min=0, max=1_700_000_000_000),
...     simulation_time=TimestampRange(min=0, max=1_700_000_000_000),
... )