Class SimulatorsAPI

Hierarchy

BaseResourceAPI<Simulator>
- SimulatorsAPI

Constructors

constructor

new SimulatorsAPI(...args: [string, CDFHttpClient, MetadataMap]): SimulatorsAPI

Overrides BaseResourceAPI.__constructor
- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:56
Parameters
- Rest ...args: [string, CDFHttpClient, MetadataMap]
Returns SimulatorsAPI

Methods

aggregateModels

aggregateModels(query: SimulatorModelAggregateQuery): Promise<AggregateResponse[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:159
Parameters
- query: SimulatorModelAggregateQuery
Returns Promise<AggregateResponse[]>

create

create(items: SimulatorCreate[]): Promise<Simulator[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:108
Parameters
- items: SimulatorCreate[]
Returns Promise<Simulator[]>

createIntegrations

createIntegrations(items: SimulatorIntegrationCreate[]): Promise<SimulatorIntegration[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:128
Parameters
- items: SimulatorIntegrationCreate[]
Returns Promise<SimulatorIntegration[]>

createModelRevisions

createModelRevisions(items: SimulatorModelRevisionCreate[]): Promise<SimulatorModelRevision[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:191
Parameters
- items: SimulatorModelRevisionCreate[]
Returns Promise<SimulatorModelRevision[]>

createModels

createModels(items: SimulatorModelCreate[]): Promise<SimulatorModel[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:171
Parameters
- items: SimulatorModelCreate[]
Returns Promise<SimulatorModel[]>

createRoutineRevisions

createRoutineRevisions(items: SimulatorRoutineRevisionCreate[]): Promise<SimulatorRoutineRevision[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:228
Parameters
- items: SimulatorRoutineRevisionCreate[]
Returns Promise<SimulatorRoutineRevision[]>

createRoutines

createRoutines(items: SimulatorRoutineCreate[]): Promise<SimulatorRoutine[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:207
Parameters
- items: SimulatorRoutineCreate[]
Returns Promise<SimulatorRoutine[]>

delete

delete(ids: IdEither[]): Promise<{}>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:120
Parameters
- ids: IdEither[]
Returns Promise<{}>

deleteIntegrations

deleteIntegrations(ids: IdEither[]): Promise<{}>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:132
Parameters
- ids: IdEither[]
Returns Promise<{}>

deleteModelRevisions

deleteModelRevisions(ids: IdEither[]): Promise<{}>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:195
Parameters
- ids: IdEither[]
Returns Promise<{}>

deleteModels

deleteModels(ids: IdEither[]): Promise<{}>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:175
Parameters
- ids: IdEither[]
Returns Promise<{}>

deleteRoutines

deleteRoutines(ids: IdEither[]): Promise<{}>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:211
Parameters
- ids: IdEither[]
Returns Promise<{}>

list

list(filter?: SimulatorFilterQuery): CursorAndAsyncIterator<Simulator>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:112
Parameters
- Optional filter: SimulatorFilterQuery
Returns CursorAndAsyncIterator<Simulator>

listIntegrations

listIntegrations(filter?: SimulatorIntegrationFilterQuery): CursorAndAsyncIterator<SimulatorIntegration>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:124
Parameters
- Optional filter: SimulatorIntegrationFilterQuery
Returns CursorAndAsyncIterator<SimulatorIntegration>

listModelRevisions

listModelRevisions(filter?: SimulatorModelRevisionFilterQuery): CursorAndAsyncIterator<SimulatorModelRevision>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:183
Parameters
- Optional filter: SimulatorModelRevisionFilterQuery
Returns CursorAndAsyncIterator<SimulatorModelRevision>

listModels

listModels(filter?: SimulatorModelFilterQuery): CursorAndAsyncIterator<SimulatorModel>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:163
Parameters
- Optional filter: SimulatorModelFilterQuery
Returns CursorAndAsyncIterator<SimulatorModel>

listRoutineRevisions

listRoutineRevisions<RevisionResponseType>(filter?: SimulatorRoutineRevisionsFilterQuery): CursorAndAsyncIterator<RevisionResponseType>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:215
Type parameters
- RevisionResponseType: SimulatorRoutineRevisionBase = SimulatorRoutineRevisionView
Parameters
- Optional filter: SimulatorRoutineRevisionsFilterQuery
Returns CursorAndAsyncIterator<RevisionResponseType>

listRoutines

listRoutines(filter?: SimulatorRoutineFilterQuery): CursorAndAsyncIterator<SimulatorRoutine>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:203
Parameters
- Optional filter: SimulatorRoutineFilterQuery
Returns CursorAndAsyncIterator<SimulatorRoutine>

listRunData

listRunData(ids: SimulationRunId[]): Promise<SimulationRunData[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:140
Parameters
- ids: SimulationRunId[]
Returns Promise<SimulationRunData[]>

listRuns

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

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

retrieveLogs

retrieveLogs(items: InternalId[]): Promise<SimulatorLog[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:232
Parameters
- items: InternalId[]
Returns Promise<SimulatorLog[]>

retrieveModelRevisions

retrieveModelRevisions(items: IdEither[]): Promise<SimulatorModelRevision[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:187
Parameters
- items: IdEither[]
Returns Promise<SimulatorModelRevision[]>

retrieveModels

retrieveModels(items: IdEither[]): Promise<SimulatorModel[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:167
Parameters
- items: IdEither[]
Returns Promise<SimulatorModel[]>

retrieveRoutineRevisions

retrieveRoutineRevisions(items: IdEither[]): Promise<SimulatorRoutineRevision[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:224
Parameters
- items: IdEither[]
Returns Promise<SimulatorRoutineRevision[]>

retrieveRuns

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

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

runSimulation

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

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:151
[Run a simulation](Run a simulation <https://developer.cognite.com/api#tag/Simulation-Runs/operation/run_simulation_simulators_run_post)
```
const simulationRun = await client.simulators.runSimulation([{ "routineExternalId": "DWSIM-ShowerMixer" }]);
```
Parameters
- items: SimulationRunCreate[]
Returns Promise<SimulationRun[]>

update

update(changes: SimulatorChange[]): Promise<Simulator[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:116
Parameters
- changes: SimulatorChange[]
Returns Promise<Simulator[]>

updateModelRevisions

updateModelRevisions(changes: SimulatorModelRevisionChange[]): Promise<SimulatorModelRevision[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:199
Parameters
- changes: SimulatorModelRevisionChange[]
Returns Promise<SimulatorModelRevision[]>

updateModels

updateModels(changes: SimulatorModelChange[]): Promise<SimulatorModel[]>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:179
Parameters
- changes: SimulatorModelChange[]
Returns Promise<SimulatorModel[]>