Jump to

• Request
• Response

Get Menus for Diagram Menu

get

/api/diagram/Menus/readForMenu

Returns the constructed list of menus and associated menu tools of a diagram menu.

Request

Query Parameters

• node: string
  The node of the tree to get. It can be either root or DiagramMenuID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of menus.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/diagramMenusReadForMenu"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• 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"
}

Nested Schema : type

Type: object

Show Source

• data: array data
  The list of menus.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of menus.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/diagramMenusReadForMenu"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of menus.

Show Source

• Array of: object diagramMenusReadForMenu

{
    "description":"The list of menus.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/diagramMenusReadForMenu"
    }
}

Nested Schema : diagramMenusReadForMenu

Type: object

Show Source

• menu: array menu
  The list of menu items.
• MenuID: integer
  The menu ID.

  Example: 2
• MenuName: string
  The menu name.

  Example: Device Info
• ParentMenuID: integer
  The parent menu ID.

  Example: 1
• text:
  The display name of the diagram menu.

  Example: Device Info
• UserGroupID: object UserGroupID
  The user group ID.
• UserGroupName: string
  The name associated with the specified UserGroupID.

  Example: Administrators

{
    "type":"object",
    "properties":{
        "MenuID":{
            "$ref":"#/components/schemas/diagramMenusRead/properties/MenuID"
        },
        "text":{
            "description":"The display name of the diagram menu.",
            "example":"Device Info"
        },
        "MenuName":{
            "$ref":"#/components/schemas/diagramMenusReadByID/properties/MenuName"
        },
        "UserGroupID":{
            "$ref":"#/components/schemas/diagramMenusReadByID/properties/UserGroupID"
        },
        "ParentMenuID":{
            "$ref":"#/components/schemas/diagramMenusReadByID/properties/ParentMenuID"
        },
        "UserGroupName":{
            "description":"The name associated with the specified UserGroupID.",
            "type":"string",
            "example":"Administrators"
        },
        "menu":{
            "description":"The list of menu items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "ToolID":{
                        "description":"The tool ID.",
                        "type":"integer",
                        "example":"2"
                    },
                    "text":{
                        "description":"The display name of the menu tool.",
                        "type":"string",
                        "example":"Device Health"
                    },
                    "ToolName":{
                        "description":"The display name of the menu tool.",
                        "type":"string",
                        "example":"Device Health"
                    },
                    "ToolTypeName":{
                        "description":"The tool type name.",
                        "type":"string",
                        "example":"View",
                        "enum":[
                            "View",
                            "SQL"
                        ]
                    },
                    "Icon":{
                        "description":"The path for the icon image file.",
                        "type":"string",
                        "example":"fugue/heart--exclamation.png"
                    },
                    "ToolPath":{
                        "description":"Relative path to view",
                        "type":"string",
                        "example":"dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>"
                    },
                    "ToolPathTypeName":{
                        "description":"The type of tool path.\nAllowed Values:\n<ul><li><b>1</b>: Local</li>\n<li><b>2</b>: Internal</li>\n<li><b>3</b>: Hybrid</li>\n<li><b>4</b>: Remote</li></ul>",
                        "type":"string",
                        "example":"Internal"
                    },
                    "ToolTarget":{
                        "description":"The tool target.\nAllowed Values:\n<ul><li>window</li>\n<li>currenttab</li>\n<li>newtab</li></ul>",
                        "type":"string",
                        "example":"window"
                    },
                    "Width":{
                        "description":"The menu tool width.",
                        "type":"integer",
                        "example":"80"
                    },
                    "Height":{
                        "description":"The menu tool height.",
                        "type":"integer",
                        "example":"80"
                    }
                }
            },
            "example":[
                {
                    "ToolID":"1",
                    "text":"Manage Device",
                    "ToolName":"Manage Device",
                    "ToolTypeName":"View",
                    "icon":"/resources/assure1/images/icons/silk/brick_go.png",
                    "ToolPath":"device/devices?filter=[{\"property\":\"DeviceName\",\"value\":\"<DeviceName>\",\"type\":\"string\",\"operator\":\"like\"}]",
                    "ToolPathTypeName":"Internal",
                    "ToolTarget":"window",
                    "Width":"500",
                    "Height":"700"
                },
                {
                    "ToolID":"2",
                    "text":"Device Health",
                    "ToolName":"Device Health",
                    "ToolTypeName":"View",
                    "icon":"/resources/assure1/images/icons/fugue/heart--exclamation.png",
                    "ToolPath":"dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>",
                    "ToolPathTypeName":"Internal",
                    "ToolTarget":"window",
                    "Width":"80",
                    "Height":"80"
                },
                {
                    "ToolID":"3",
                    "text":"Network Details",
                    "ToolName":"Network Details",
                    "ToolTypeName":"View",
                    "icon":"/resources/assure1/images/icons/fugue/network-clouds.png",
                    "ToolPath":"dashboard/Network%20Details?DeviceName=<DeviceName>&StartVertexName=<DeviceName>&GraphType=VertexList&GroupByVertexTypeName=No%20Grouping&VertexTuckAwayTypeName=Interface",
                    "ToolPathTypeName":"Internal",
                    "ToolTarget":"window",
                    "Width":"80",
                    "Height":"80"
                }
            ]
        }
    }
}

Nested Schema : menu

Type: array

The list of menu items.

Show Source

• Array of: object items

{
    "description":"The list of menu items.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ToolID":{
                "description":"The tool ID.",
                "type":"integer",
                "example":"2"
            },
            "text":{
                "description":"The display name of the menu tool.",
                "type":"string",
                "example":"Device Health"
            },
            "ToolName":{
                "description":"The display name of the menu tool.",
                "type":"string",
                "example":"Device Health"
            },
            "ToolTypeName":{
                "description":"The tool type name.",
                "type":"string",
                "example":"View",
                "enum":[
                    "View",
                    "SQL"
                ]
            },
            "Icon":{
                "description":"The path for the icon image file.",
                "type":"string",
                "example":"fugue/heart--exclamation.png"
            },
            "ToolPath":{
                "description":"Relative path to view",
                "type":"string",
                "example":"dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>"
            },
            "ToolPathTypeName":{
                "description":"The type of tool path.\nAllowed Values:\n<ul><li><b>1</b>: Local</li>\n<li><b>2</b>: Internal</li>\n<li><b>3</b>: Hybrid</li>\n<li><b>4</b>: Remote</li></ul>",
                "type":"string",
                "example":"Internal"
            },
            "ToolTarget":{
                "description":"The tool target.\nAllowed Values:\n<ul><li>window</li>\n<li>currenttab</li>\n<li>newtab</li></ul>",
                "type":"string",
                "example":"window"
            },
            "Width":{
                "description":"The menu tool width.",
                "type":"integer",
                "example":"80"
            },
            "Height":{
                "description":"The menu tool height.",
                "type":"integer",
                "example":"80"
            }
        }
    },
    "example":[
        {
            "ToolID":"1",
            "text":"Manage Device",
            "ToolName":"Manage Device",
            "ToolTypeName":"View",
            "icon":"/resources/assure1/images/icons/silk/brick_go.png",
            "ToolPath":"device/devices?filter=[{\"property\":\"DeviceName\",\"value\":\"<DeviceName>\",\"type\":\"string\",\"operator\":\"like\"}]",
            "ToolPathTypeName":"Internal",
            "ToolTarget":"window",
            "Width":"500",
            "Height":"700"
        },
        {
            "ToolID":"2",
            "text":"Device Health",
            "ToolName":"Device Health",
            "ToolTypeName":"View",
            "icon":"/resources/assure1/images/icons/fugue/heart--exclamation.png",
            "ToolPath":"dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>",
            "ToolPathTypeName":"Internal",
            "ToolTarget":"window",
            "Width":"80",
            "Height":"80"
        },
        {
            "ToolID":"3",
            "text":"Network Details",
            "ToolName":"Network Details",
            "ToolTypeName":"View",
            "icon":"/resources/assure1/images/icons/fugue/network-clouds.png",
            "ToolPath":"dashboard/Network%20Details?DeviceName=<DeviceName>&StartVertexName=<DeviceName>&GraphType=VertexList&GroupByVertexTypeName=No%20Grouping&VertexTuckAwayTypeName=Interface",
            "ToolPathTypeName":"Internal",
            "ToolTarget":"window",
            "Width":"80",
            "Height":"80"
        }
    ]
}

Example:

[
    {
        "ToolID":"1",
        "text":"Manage Device",
        "ToolName":"Manage Device",
        "ToolTypeName":"View",
        "icon":"/resources/assure1/images/icons/silk/brick_go.png",
        "ToolPath":"device/devices?filter=[{\"property\":\"DeviceName\",\"value\":\"<DeviceName>\",\"type\":\"string\",\"operator\":\"like\"}]",
        "ToolPathTypeName":"Internal",
        "ToolTarget":"window",
        "Width":"500",
        "Height":"700"
    },
    {
        "ToolID":"2",
        "text":"Device Health",
        "ToolName":"Device Health",
        "ToolTypeName":"View",
        "icon":"/resources/assure1/images/icons/fugue/heart--exclamation.png",
        "ToolPath":"dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>",
        "ToolPathTypeName":"Internal",
        "ToolTarget":"window",
        "Width":"80",
        "Height":"80"
    },
    {
        "ToolID":"3",
        "text":"Network Details",
        "ToolName":"Network Details",
        "ToolTypeName":"View",
        "icon":"/resources/assure1/images/icons/fugue/network-clouds.png",
        "ToolPath":"dashboard/Network%20Details?DeviceName=<DeviceName>&StartVertexName=<DeviceName>&GraphType=VertexList&GroupByVertexTypeName=No%20Grouping&VertexTuckAwayTypeName=Interface",
        "ToolPathTypeName":"Internal",
        "ToolTarget":"window",
        "Width":"80",
        "Height":"80"
    }
]

Nested Schema : UserGroupID

Type: object

The user group ID.

Show Source

• id:
  Example: 1
• name:
  Example: Administrators

{
    "description":"The user group ID.",
    "type":"object",
    "properties":{
        "id":{
            "example":"1"
        },
        "name":{
            "example":"Administrators"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• Height: integer
  The menu tool height.

  Example: 80
• Icon: string
  The path for the icon image file.

  Example: fugue/heart--exclamation.png
• text: string
  The display name of the menu tool.

  Example: Device Health
• ToolID: integer
  The tool ID.

  Example: 2
• ToolName: string
  The display name of the menu tool.

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

  Example: dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>
• ToolPathTypeName: string
  The type of tool path. Allowed Values:

  • 1: Local
  • 2: Internal
  • 3: Hybrid
  • 4: Remote

  Example: Internal
• ToolTarget: string
  The tool target. Allowed Values:

  • window
  • currenttab
  • newtab

  Example: window
• ToolTypeName: string
  Allowed Values: [ "View", "SQL" ]

  The tool type name.

  Example: View
• Width: integer
  The menu tool width.

  Example: 80

{
    "type":"object",
    "properties":{
        "ToolID":{
            "description":"The tool ID.",
            "type":"integer",
            "example":"2"
        },
        "text":{
            "description":"The display name of the menu tool.",
            "type":"string",
            "example":"Device Health"
        },
        "ToolName":{
            "description":"The display name of the menu tool.",
            "type":"string",
            "example":"Device Health"
        },
        "ToolTypeName":{
            "description":"The tool type name.",
            "type":"string",
            "example":"View",
            "enum":[
                "View",
                "SQL"
            ]
        },
        "Icon":{
            "description":"The path for the icon image file.",
            "type":"string",
            "example":"fugue/heart--exclamation.png"
        },
        "ToolPath":{
            "description":"Relative path to view",
            "type":"string",
            "example":"dashboard/Device%20Overview?DeviceName=<DeviceName>&FilterType=DeviceName&FilterValue=<DeviceName>&DeviceZoneName=<DeviceZoneName>"
        },
        "ToolPathTypeName":{
            "description":"The type of tool path.\nAllowed Values:\n<ul><li><b>1</b>: Local</li>\n<li><b>2</b>: Internal</li>\n<li><b>3</b>: Hybrid</li>\n<li><b>4</b>: Remote</li></ul>",
            "type":"string",
            "example":"Internal"
        },
        "ToolTarget":{
            "description":"The tool target.\nAllowed Values:\n<ul><li>window</li>\n<li>currenttab</li>\n<li>newtab</li></ul>",
            "type":"string",
            "example":"window"
        },
        "Width":{
            "description":"The menu tool width.",
            "type":"integer",
            "example":"80"
        },
        "Height":{
            "description":"The menu tool height.",
            "type":"integer",
            "example":"80"
        }
    }
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• 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"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• 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"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top