Get Tools in a Menu
get
/api/topology/Menus/readForMenu
Get all the tools in the menu. The menu is either the restrictive menu or the default menu.
Request
There are no request parameters for this operation.
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 : topologyMenusReadForMenu
Type:
Show Source
object
-
Height: integer
Height in pixels if tool target is window.Example:
80
-
Icon: string
Tool icon for menu displayExample:
fugue/heart--exclamation.png
-
text: string
Tool NameExample:
Device Overview
-
ToolID: integer
Tool IDExample:
1
-
ToolName: string
Tool NameExample:
Device Overview
-
ToolPath: string
Relative path to viewExample:
dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneID=<DeviceZoneID>
-
ToolPathTypeName: string
Tool Path Type NameExample:
Internal
-
ToolTarget: string
Tool Target Allowed Values: - window - currenttab - newtabExample:
window
-
ToolTypeName: string
Tool Type NameExample:
View
-
Width: integer
Width in pixels if tool target is window.Example:
80
Example:
[
{
"ToolI":"1",
"text":"Device Overview",
"ToolName":"Device Overview",
"ToolTypeName":"View",
"icon":"/resources/assure1/images/icons/fugue/heart--exclamation.png",
"ToolPath":"dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneID=<DeviceZoneID>",
"ToolPathTypeName":"Internal",
"ToolTarget":"window",
"Width":"80",
"Height":"80"
},
{
"ToolID":"2",
"text":"Events",
"ToolName":"Events",
"ToolTypeName":"View",
"icon":"/resources/assure1/images/icons/fugue/funnel--exclamation.png",
"ToolPath":"event/events/EventsGrid?FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneID=<DeviceZoneID>",
"ToolPathTypeName":"Internal",
"ToolTarget":"window",
"Width":"80",
"Height":"80"
},
{
"ToolID":"3",
"text":"Device Availability",
"ToolName":"Device Availability",
"ToolTypeName":"View",
"icon":"/resources/assure1/images/icons/silk/brick_go.png",
"ToolPath":"metric/availabilityData?DeviceName=<DeviceName>&TimeRange=now-24h..now&DeviceZoneID=<DeviceZoneID>",
"ToolPathTypeName":"Internal",
"ToolTarget":"window",
"Width":"80",
"Height":"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