Class SimulationRunsAPI

Hierarchy

BaseResourceAPI<SimulationRun>
- SimulationRunsAPI

Index

Methods

Methods

list

list(filter?: SimulationRunFilterQuery): CursorAndAsyncIterator<SimulationRun>

- Defined in packages/alpha/src/api/simulators/simulationRunsApi.ts:26
Parameters
- Optional filter: SimulationRunFilterQuery
Returns CursorAndAsyncIterator<SimulationRun>

retrieve

retrieve(ids: CogniteInternalId[]): Promise<SimulationRun[]>

- Defined in packages/alpha/src/api/simulators/simulationRunsApi.ts:33
Parameters
- ids: CogniteInternalId[]
Returns Promise<SimulationRun[]>

run

run(items: SimulationRunCreate[]): Promise<SimulationRun[]>

- Defined in packages/alpha/src/api/simulators/simulationRunsApi.ts:21
Parameters
- items: SimulationRunCreate[]
Returns Promise<SimulationRun[]>