Retrieve simulation runs

async AsyncCogniteClient.simulators.runs.retrieve(

ids: int | Sequence[int],

) → SimulationRun | SimulationRunList | None

Retrieve simulation runs by ID

Parameters:

ids (int | Sequence[int]) – The ID(s) of the simulation run(s) to retrieve.

Returns:

The simulation run(s) with the given ID(s)

Return type:

SimulationRun | SimulationRunList | None

Examples

Retrieve a single simulation run by id:

>>> from cognite.client import CogniteClient, AsyncCogniteClient
>>> client = CogniteClient()
>>> # async_client = AsyncCogniteClient()  # another option
>>> run = client.simulators.runs.retrieve(ids=2)