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/modelsApi"
ModelsAPI
Class ModelsAPI
Hierarchy
BaseResourceAPI
<
SimulatorModel
>
ModelsAPI
Index
Constructors
constructor
Methods
create
delete
list
retrieve
update
Constructors
constructor
new
ModelsAPI
(
...
args
:
[
string
,
CDFHttpClient
,
MetadataMap
]
)
:
ModelsAPI
Parameters
Rest
...
args:
[
string
,
CDFHttpClient
,
MetadataMap
]
Returns
ModelsAPI
Methods
create
create
(
items
:
SimulatorModelCreate
[]
)
:
Promise
<
SimulatorModel
[]
>
Parameters
items:
SimulatorModelCreate
[]
Returns
Promise
<
SimulatorModel
[]
>
delete
delete
(
ids
:
IdEither
[]
)
:
Promise
<
{}
>
Parameters
ids:
IdEither
[]
Returns
Promise
<
{}
>
list
list
(
filter
?:
SimulatorModelFilterQuery
)
:
Promise
<
ListResponse
<
SimulatorModel
[]
>
>
Parameters
Optional
filter:
SimulatorModelFilterQuery
Returns
Promise
<
ListResponse
<
SimulatorModel
[]
>
>
retrieve
retrieve
(
items
:
IdEither
[]
)
:
Promise
<
SimulatorModel
[]
>
Parameters
items:
IdEither
[]
Returns
Promise
<
SimulatorModel
[]
>
update
update
(
changes
:
SimulatorModelChange
[]
)
:
Promise
<
SimulatorModel
[]
>
Parameters
changes:
SimulatorModelChange
[]
Returns
Promise
<
SimulatorModel
[]
>
Globals
"alpha/src/api/simulators/models
Api"
ModelsAPI
constructor
create
delete
list
retrieve
update