Search
Preparing search index...
The search index is not available
Cognite JavaScript SDK
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"alpha/src/api/simulators/simulationRunsApi"
SimulationRunsAPI
Class SimulationRunsAPI
Hierarchy
BaseResourceAPI
<
SimulationRun
>
SimulationRunsAPI
Index
Constructors
constructor
Methods
list
retrieve
run
Constructors
constructor
new
Simulation
RunsAPI
(
...
args
:
[
string
,
CDFHttpClient
,
MetadataMap
]
)
:
SimulationRunsAPI
Parameters
Rest
...
args:
[
string
,
CDFHttpClient
,
MetadataMap
]
Returns
SimulationRunsAPI
Methods
list
list
(
filter
?:
SimulationRunFilterQuery
)
:
Promise
<
ListResponse
<
SimulationRun
[]
>
>
Parameters
Optional
filter:
SimulationRunFilterQuery
Returns
Promise
<
ListResponse
<
SimulationRun
[]
>
>
retrieve
retrieve
(
ids
:
CogniteInternalId
[]
)
:
Promise
<
SimulationRun
[]
>
Parameters
ids:
CogniteInternalId
[]
Returns
Promise
<
SimulationRun
[]
>
run
run
(
items
:
SimulationRunCreate
[]
)
:
Promise
<
SimulationRun
[]
>
Parameters
items:
SimulationRunCreate
[]
Returns
Promise
<
SimulationRun
[]
>
Globals
"alpha/src/api/simulators/simulation
Runs
Api"
Simulation
RunsAPI
constructor
list
retrieve
run