1. REST API for Unified Assurance Core
  2. Tasks
  3. Topology
  4. Topology Menus

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 Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulGetOperation
Type: object
The response body for a successful get operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : topologyMenusReadForMenu
Type: object
Show Source
  • Used when toolTarget is set to window. The height of the pop-up window. Any value between 10 and 90 is treated as a percentage of the overall browser height. Any value greater than 100 is treated as an absolute pixel value.
    Example: 80
  • The icon used for the tool in menus.
    Example: fugue/heart--exclamation.png
  • The name of the tool.
    Example: Device Overview
  • The tool ID.
    Example: 1
  • The name of the tool.
    Example: Device Overview
  • The path to the web page to open, or script or function to run, depending on the value of Path Type.
    If the value starts with a string and ://, such as https://, this is an absolute path. Otherwise, the path is relative to the $A1BASEDIR/www/tools/topology/ directory.
    You can use tokens in the path in the format <Property> to represent object properties. When the tool is run, tokens are replaced with actual values. For example, <DeviceID> is replaced with the value from the object's DeviceID property. Common tokens include:
    • <DeviceID>
    • <ObjectID>
    • <OwnerUserID>
    • <OwnerUserGroupID>
    Example: dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneID=<DeviceZoneID>
  • The name of the tool path type.
    Example: Internal
  • How the tool opens new pages.
    Possible values are:
    • window: Opens in a pop-up window.
    • currenttab: Opens in the current browser tab.
    • newtab: Opens in a new browser tab.
    Example: window
  • The name of the tool type. For topology tools, this is always View.
    Example: View
  • Used when toolTarget is set to window. The width of the pop-up window. Any value between 10 and 90 is treated as a percentage of the overall browser width. Any value greater than 100 is treated as an absolute pixel value.
    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
Body ()
Root Schema : schema
Type: object
Show Source
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
An error.
Back to Top