Methods
static
create(createData) → {Promise.<RTUPluginModel>}
Create a RTU Plugin [POST /rtu-plugins]
Parameters
-
createData
RTUPluginController.CreateDataThe RTU Plugin Create Data
Returns
-
Promise.<RTUPluginModel>
Source
static
delete(id) → {Promise.<boolean>}
Delete a RTU Plugin [DELETE /rtu-plugins/{id}]
Parameters
-
id
numberThe RTU Plugin ID
Returns
-
Promise.<boolean>
Source
static
getAll(queryParametersopt) → {Promise.<Array.<RTUPluginModel>>}
List all RTU Plugins [GET /rtu-plugins]
Parameters
-
queryParameters
RTUPluginController.GetAllQueryParameters<optional>
The Optional Query Parameters
Returns
-
Promise.<Array.<RTUPluginModel>>
Source
static
getOne(id) → {Promise.<RTUPluginModel>}
Retrieve a RTU Plugin [GET /rtu-plugins/{id}]
Parameters
-
id
numberThe RTU Plugin ID
Returns
-
Promise.<RTUPluginModel>
Source
static
update(id, updateData) → {Promise.<RTUPluginModel>}
Update a RTU Plugin [PATCH /rtu-plugins/{id}]
Parameters
-
id
numberThe RTU Plugin ID
-
updateData
RTUPluginController.UpdateDataThe RTU Plugin Update Data
Returns
-
Promise.<RTUPluginModel>
Source
Type Definitions
CreateData
The Create Data for a RTU Plugin
Type
-
Object
Properties
-
name
stringThe Plugin Name
-
companyId
stringThe Company this RTU Plugin belongs to
Source
GetAllQueryParameters
The Optional Query Parameters for the getAll Function
Type
-
Object
Properties
-
name
string<optional>
The Plugin Name
-
companyId
string<optional>
The Company this RTU Plugin belongs to
Source
UpdateData
The Update Data for a RTU Plugin
Type
-
Object
Properties
-
name
string<optional>
The Plugin Name
-
companyId
string<optional>
The Company this RTU Plugin belongs to