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:53
Parameters
- Rest ...args: [string, CDFHttpClient, MetadataMap]
Returns SimulatorsAPI

Methods

create

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

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

createIntegrations

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

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

createModelRevisions

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

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

createModels

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

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

createRoutineRevisions

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

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

createRoutines

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

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

delete

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

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

deleteIntegrations

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

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

deleteModelRevisions

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

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

deleteModels

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

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

deleteRoutines

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

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

list

list(filter?: SimulatorFilterQuery): Promise<ListResponse<Simulator[]>>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:109
Parameters
- Optional filter: SimulatorFilterQuery
Returns Promise<ListResponse<Simulator[]>>

listIntegrations

listIntegrations(filter?: SimulatorIntegrationFilterQuery): Promise<ListResponse<SimulatorIntegration[]>>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:121
Parameters
- Optional filter: SimulatorIntegrationFilterQuery
Returns Promise<ListResponse<SimulatorIntegration[]>>

listModelRevisions

listModelRevisions(filter?: SimulatorModelRevisionFilterQuery): Promise<ListResponse<SimulatorModelRevision[]>>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:171
Parameters
- Optional filter: SimulatorModelRevisionFilterQuery
Returns Promise<ListResponse<SimulatorModelRevision[]>>

listModels

listModels(filter?: SimulatorModelFilterQuery): Promise<ListResponse<SimulatorModel[]>>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:151
Parameters
- Optional filter: SimulatorModelFilterQuery
Returns Promise<ListResponse<SimulatorModel[]>>

listRoutineRevisions

listRoutineRevisions(filter?: SimulatorRoutineRevisionsFilterQuery): Promise<ListResponse<SimulatorRoutineRevision[]>>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:209
Parameters
- Optional filter: SimulatorRoutineRevisionsFilterQuery
Returns Promise<ListResponse<SimulatorRoutineRevision[]>>

listRoutines

listRoutines(filter?: SimulatorRoutineFilterQuery): Promise<ListResponse<SimulatorRoutine[]>>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:197
Parameters
- Optional filter: SimulatorRoutineFilterQuery
Returns Promise<ListResponse<SimulatorRoutine[]>>

listRunData

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

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

listRuns

listRuns(filter?: SimulationRunFilterQuery): Promise<ListResponse<SimulationRun[]>>

- Defined in packages/alpha/src/api/simulators/simulatorsApi.ts:135
Parameters
- Optional filter: SimulationRunFilterQuery
Returns Promise<ListResponse<SimulationRun[]>>

retrieveLogs

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

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

retrieveModelRevisions

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

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

retrieveModels

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

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

retrieveRoutineRevisions

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

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

retrieveRuns

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

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

runSimulation

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

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

update

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

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

updateModelRevisions

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

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

updateModels

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

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