• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/topologyMenusReadForMenu"
                    }
                }
            }
        }
    ]
}

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/topologyMenusReadForMenu"
            }
        }
    }
}

• Array of: object topologyMenusReadForMenu

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/topologyMenusReadForMenu"
    }
}

• Height: integer
  Height in pixels if tool target is window.

  Example: 80
• Icon: string
  Tool icon for menu display

  Example: fugue/heart--exclamation.png
• text: string
  Tool Name

  Example: Device Overview
• ToolID: integer
  Tool ID

  Example: 1
• ToolName: string
  Tool Name

  Example: Device Overview
• ToolPath: string
  Relative path to view

  Example: dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneID=<DeviceZoneID>
• ToolPathTypeName: string
  Tool Path Type Name

  Example: Internal
• ToolTarget: string
  Tool Target Allowed Values: - window - currenttab - newtab

  Example: window
• ToolTypeName: string
  Tool Type Name

  Example: View
• Width: integer
  Width in pixels if tool target is window.

  Example: 80

{
    "properties":{
        "ToolID":{
            "$ref":"#/components/schemas/topologyToolsRead/properties/ToolID"
        },
        "text":{
            "$ref":"#/components/schemas/topologyToolsRead/properties/ToolName"
        },
        "ToolName":{
            "$ref":"#/components/schemas/topologyToolsRead/properties/ToolName"
        },
        "ToolTypeName":{
            "$ref":"#/components/schemas/topologyToolsRead/properties/ToolTypeName"
        },
        "Icon":{
            "$ref":"#/components/schemas/topologyToolsRead/properties/Icon"
        },
        "ToolPath":{
            "$ref":"#/components/schemas/topologyToolsRead/properties/ToolPath"
        },
        "ToolPathTypeName":{
            "$ref":"#/components/schemas/topologyToolsRead/properties/ToolPathTypeName"
        },
        "ToolTarget":{
            "$ref":"#/components/schemas/topologyToolsRead/properties/ToolTarget"
        },
        "Width":{
            "$ref":"#/components/schemas/topologyToolsRead/properties/Width"
        },
        "Height":{
            "$ref":"#/components/schemas/topologyToolsRead/properties/Height"
        }
    },
    "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"
        }
    ],
    "type":"object"
}

[
    {
        "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"
    }
]

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

• Array of: object items
  An error.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}