List simulator models

async AsyncCogniteClient.simulators.models.list(

limit: int | None = 25,

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

sort: PropertySort | None = None,

) → SimulatorModelList

Filter simulator models

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

Parameters:

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

• simulator_external_ids (str | SequenceNotStr[str] | None) – Filter by simulator external id(s).

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

Returns:

List of simulator models

Return type:

SimulatorModelList

Examples

List simulator models:

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

Iterate over simulator models, one-by-one:

>>> for model in client.simulators.models():
...     model  # do something with the simulator model

Specify filter and sort order:

>>> from cognite.client.data_classes.simulators.filters import PropertySort
>>> res = client.simulators.models.list(
...     simulator_external_ids=["simulator_external_id"],
...     sort=PropertySort(property="createdTime", order="asc"),
... )