Run a View Tool
get
/api/diagram/Tools/executeViewTool/{id}
Runs a view tool when a user selects a context menu from a diagram widget in the UI.
Request
Path Parameters
-
id(required): integer
The ID of the selected diagram menu tool.
Query Parameters
-
WidgetProps(required): object
Properties of the selected diagram widget.Example:
{ "id":"Widget_1-451", "transform":"translate(196, 111) rotate(0, 32, 32)", "WidgetType":"BasicEllipse", "LinkType":"None", "LinkTarget":"", "LinkValue":"", "LinkExtra":"", "MenuID":"5", "cursor":"" }
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : diagramToolsRead
Type:
Show Source
object
-
Height: integer
Height when the "View" tool is launched in window , i.e. ToolTarget = windowExample:
80
-
Icon: string
Relative image path for the icon.Example:
fugue/heart--exclamation.png
-
ToolID: integer
Unique identifier for the tool.Example:
2
-
ToolName: string
Name of the tool.Example:
Device Health
-
ToolPath: string
URL path for the "View" tool.Example:
dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>
-
ToolPathType: string
Controls how the "View" tool is being executed with the associated diagram widget. Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => RemoteExample:
Internal
-
ToolPathTypeID: integer
Unique identifier for tool path type. Controls how the "View" tool is being executed with the associated diagram widget. Allowed Values: - 1 => Local - 2 => Internal - 3 => Hybrid - 4 => RemoteExample:
2
-
ToolTarget: string
Allowed Values:
[ "window", "currenttab", "newtab" ]
Controls how the "View" tool is being launched in display.Example:window
-
ToolTypeID: integer
Tool type ID Allowed Values: - 1 => View - the menu tool executes in URL path. - 2 => SQL - the menu tool executes in SQL statements.Example:
1
-
ToolTypeName: string
Name of the tool type associated with ToolTypeID.Example:
View
-
Width: integer
Width when the "View" tool is launched in window , i.e. ToolTarget = windowExample:
80
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
errors: array
errors
The list of errors reported. Validation errors will be keyed by record field.
-
message: string
The response message.Example:
Exception thrown
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
false
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object