Model service
Actions
Endpoint |
Brief Description |
Macro |
|---|---|---|
Deletes a model. |
OT_ACTION_CMD_MODEL_Delete |
|
Saves a project in the database. |
OT_ACTION_CMD_PROJ_Save |
|
Changes a selection. |
OT_ACTION_CMD_MODEL_SelectionChanged |
|
Renames a model item. |
OT_ACTION_CMD_MODEL_ItemRenamed |
|
Visualizes a model. |
OT_ACTION_CMD_SetVisualizationModel |
|
Gets the visualization Model ID. |
OT_ACTION_CMD_GetVisualizationModel |
|
Checks if the model has been modified. |
OT_ACTION_CMD_MODEL_GetIsModified |
|
Shows a table view in the UI. |
OT_ACTION_CMD_UI_TABLE_Setup |
|
Shows a data view in the UI. |
OT_ACTION_CMD_MODEL_RequestVisualisationData |
Model.Delete
Brief description
Deletes a model.
Message Type
mTLS
Parameters
No parameters are required.
Response
An empty String.
Project.Save
Brief description
Saves a project in the database.
Message Type
mTLS
Parameters
No parameters are required.
Response
In case of success will return an empty String.
In case of error will return a String with prefix “Error: “.
Model.Event.SelectionChanged
Brief description
Changes a selection.
Message Type
mTLS
Parameters
No parameters are required.
Response
An empty String.
Model.Event.ItemRenamed
Brief description
Renames a model item.
Message Type
mTLS
Parameters
Name |
Type |
Description |
Macro |
|---|---|---|---|
Model.ID |
Unsigned Integer 64 |
Model ID (if model exists) |
OT_ACTION_PARAM_MODEL_ID |
Model.Item.Name |
String |
New name (if model exists) |
OT_ACTION_PARAM_MODEL_ITM_Name |
Response
In case of success will return an empty String.
In case of error will return a String with prefix “Error: “.
VisualizationModel.Set
Brief description
Opens a project and visualizes a model.
Message Type
mTLS
Parameters
Name |
Type |
Description |
Macro |
|---|---|---|---|
Model.ID |
Unsigned Integer 64 |
Model ID (if model exists) |
OT_ACTION_PARAM_MODEL_ID |
View.ID |
Unsigned Integer 64 |
View ID |
OT_ACTION_PARAM_VIEW_ID |
Response
In case of success will return an empty String.
In case of error will return a String with prefix “Error: “.
VisualizationModel.Get
Brief description
Gets the visualization Model ID.
Message Type
mTLS
Parameters
No parameters are required.
Response
Name |
Type |
Description |
Macro |
|---|---|---|---|
BaseTypes.UID |
Unsigned Integer 64 |
Visualization Model ID (if successful) |
OT_ACTION_PARAM_BASETYPE_UID |
In case of error will return a String with prefix “Error: “.
Model.State.Modified.Get
Brief description
Checks if the model has been modified.
Message Type
mTLS
Parameters
No parameters are required.
Response
Name |
Type |
Description |
Macro |
|---|---|---|---|
BaseTypes.Boolean |
Boolean |
Is model modified (if successful) |
OT_ACTION_PARAM_BASETYPE_Bool |
In case of error will return a String with prefix “Error: “.
UI.Table.Setup
Brief description
Shows a data view in the UI.
Message Type
mTLS
Parameters
Name |
Type |
Description |
Macro |
|---|---|---|---|
Name |
String |
Table name |
OT_ACTION_PARAM_NAME |
View.ActiveView.Set |
Boolean |
Is view set active |
OT_ACTION_PARAM_VIEW_SetActiveView |
Response
A String containing an ot::ReturnMessage.
Model.Visualisation.Data
Brief description
Shows a data view in the UI.
Message Type
mTLS
Parameters
Name |
Type |
Description |
Macro |
|---|---|---|---|
Model.Entity.ID |
Unsigned Integer 64 |
Entity ID |
OT_ACTION_PARAM_MODEL_EntityID |
Model.Event.Functions.Name |
String |
Visualisation type |
OT_ACTION_PARAM_MODEL_FunctionName |
View.ActiveView.Set |
Boolean |
Is view set active |
OT_ACTION_PARAM_VIEW_SetActiveView |
Response
A String containing an ot::ReturnMessage.