Jump to

• Request
• Response

Get Menu Items of an Event Menu

get

/api/event/Menus/readForMenu

Gets the menu items of the specified event menu.

Request

Query Parameters

• node(required): string
  The node of the tree to get. You can specify root or the numerical event menu ID.

  Example:

  root

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 menu items of the specified event menu.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/eventMenusReadForMenu"
                    }
                }
            }
        }
    ]
}

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 menu items of the specified event menu.
• 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 menu items of the specified event menu.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/eventMenusReadForMenu"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of menu items of the specified event menu.

Show Source

• Array of: object eventMenusReadForMenu

{
    "description":"The list of menu items of the specified event menu.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/eventMenusReadForMenu"
    }
}

Nested Schema : eventMenusReadForMenu

Type: object

Show Source

• realtime: object realtime

{
    "type":"object",
    "properties":{
        "realtime":{
            "type":"object",
            "properties":{
                "MenuID":{
                    "description":"The event menu ID.",
                    "type":"integer",
                    "example":"4"
                },
                "MenuName":{
                    "description":"Menu Name",
                    "type":"string",
                    "example":"Search KB"
                },
                "text":{
                    "description":"Menu name.",
                    "type":"string",
                    "example":"Search KB"
                },
                "UserGroupID":{
                    "description":"User Group ID",
                    "type":"integer",
                    "example":"1"
                },
                "DefaultMenu":{
                    "description":"Flag to indicate if this is the default menu or not.",
                    "type":"integer",
                    "example":"0"
                },
                "ParentMenuID":{
                    "description":"Parent Menu ID",
                    "type":"integer",
                    "example":"2"
                },
                "UserGroupName":{
                    "description":"User Group name",
                    "type":"string",
                    "example":"Administrators"
                },
                "menu":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "ToolID":{
                                "description":"Menu tool ID.",
                                "type":"integer",
                                "example":"20"
                            },
                            "text":{
                                "description":"Tool Name.",
                                "type":"string",
                                "example":"By Device"
                            },
                            "ToolName":{
                                "description":"Tool Name.",
                                "type":"string",
                                "example":"By Device"
                            },
                            "ToolTypeName":{
                                "description":"The tool type can be either \"View\" or \"SQL\".",
                                "type":"string",
                                "example":"View"
                            },
                            "icon":{
                                "description":"Path to the icon image to use in the menu.",
                                "type":"string",
                                "example":"/resources/assure1/images/icons/misc/BookSearch.png"
                            },
                            "ToolPath":{
                                "description":"Path to launch the view tool. SQL tools do not have a path.",
                                "type":"string",
                                "example":"Knowledgebase.php?Action=Search;Type=Device;EventID=<EventID>"
                            },
                            "ToolPathTypeName":{
                                "description":"Indicator for what type of view tool this is.\nAllowed values are local, hybrid, internal, remote.",
                                "type":"string",
                                "example":"Local"
                            },
                            "ContextID":{
                                "example":"1"
                            },
                            "AugmentData":{
                                "description":"Flag to indicate if the event information is available to the tool.",
                                "type":"integer",
                                "example":"1"
                            },
                            "Refresh":{
                                "description":"Flag to indicate if the event list will be unpaused and refreshed when the tool finishes.",
                                "type":"integer",
                                "example":"0"
                            },
                            "ToolTarget":{
                                "description":"How to handle the tool contents. Allowed values are newtab, window, or currenttab. Newtab opens the tool in a new browser tab. Currenttab opens the tool in the current tab. Window opens the tool in a new browser window.",
                                "type":"string",
                                "example":"window"
                            },
                            "Height":{
                                "description":"Tool window height in pixels.",
                                "type":"integer",
                                "example":"600"
                            },
                            "Width":{
                                "description":"Tool window width in pixels.",
                                "type":"integer",
                                "example":"800"
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : realtime

Type: object

Show Source

• DefaultMenu: integer
  Flag to indicate if this is the default menu or not.

  Example: 0
• menu: array menu
• MenuID: integer
  The event menu ID.

  Example: 4
• MenuName: string
  Menu Name

  Example: Search KB
• ParentMenuID: integer
  Parent Menu ID

  Example: 2
• text: string
  Menu name.

  Example: Search KB
• UserGroupID: integer
  User Group ID

  Example: 1
• UserGroupName: string
  User Group name

  Example: Administrators

{
    "type":"object",
    "properties":{
        "MenuID":{
            "description":"The event menu ID.",
            "type":"integer",
            "example":"4"
        },
        "MenuName":{
            "description":"Menu Name",
            "type":"string",
            "example":"Search KB"
        },
        "text":{
            "description":"Menu name.",
            "type":"string",
            "example":"Search KB"
        },
        "UserGroupID":{
            "description":"User Group ID",
            "type":"integer",
            "example":"1"
        },
        "DefaultMenu":{
            "description":"Flag to indicate if this is the default menu or not.",
            "type":"integer",
            "example":"0"
        },
        "ParentMenuID":{
            "description":"Parent Menu ID",
            "type":"integer",
            "example":"2"
        },
        "UserGroupName":{
            "description":"User Group name",
            "type":"string",
            "example":"Administrators"
        },
        "menu":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "ToolID":{
                        "description":"Menu tool ID.",
                        "type":"integer",
                        "example":"20"
                    },
                    "text":{
                        "description":"Tool Name.",
                        "type":"string",
                        "example":"By Device"
                    },
                    "ToolName":{
                        "description":"Tool Name.",
                        "type":"string",
                        "example":"By Device"
                    },
                    "ToolTypeName":{
                        "description":"The tool type can be either \"View\" or \"SQL\".",
                        "type":"string",
                        "example":"View"
                    },
                    "icon":{
                        "description":"Path to the icon image to use in the menu.",
                        "type":"string",
                        "example":"/resources/assure1/images/icons/misc/BookSearch.png"
                    },
                    "ToolPath":{
                        "description":"Path to launch the view tool. SQL tools do not have a path.",
                        "type":"string",
                        "example":"Knowledgebase.php?Action=Search;Type=Device;EventID=<EventID>"
                    },
                    "ToolPathTypeName":{
                        "description":"Indicator for what type of view tool this is.\nAllowed values are local, hybrid, internal, remote.",
                        "type":"string",
                        "example":"Local"
                    },
                    "ContextID":{
                        "example":"1"
                    },
                    "AugmentData":{
                        "description":"Flag to indicate if the event information is available to the tool.",
                        "type":"integer",
                        "example":"1"
                    },
                    "Refresh":{
                        "description":"Flag to indicate if the event list will be unpaused and refreshed when the tool finishes.",
                        "type":"integer",
                        "example":"0"
                    },
                    "ToolTarget":{
                        "description":"How to handle the tool contents. Allowed values are newtab, window, or currenttab. Newtab opens the tool in a new browser tab. Currenttab opens the tool in the current tab. Window opens the tool in a new browser window.",
                        "type":"string",
                        "example":"window"
                    },
                    "Height":{
                        "description":"Tool window height in pixels.",
                        "type":"integer",
                        "example":"600"
                    },
                    "Width":{
                        "description":"Tool window width in pixels.",
                        "type":"integer",
                        "example":"800"
                    }
                }
            }
        }
    }
}

Nested Schema : menu

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ToolID":{
                "description":"Menu tool ID.",
                "type":"integer",
                "example":"20"
            },
            "text":{
                "description":"Tool Name.",
                "type":"string",
                "example":"By Device"
            },
            "ToolName":{
                "description":"Tool Name.",
                "type":"string",
                "example":"By Device"
            },
            "ToolTypeName":{
                "description":"The tool type can be either \"View\" or \"SQL\".",
                "type":"string",
                "example":"View"
            },
            "icon":{
                "description":"Path to the icon image to use in the menu.",
                "type":"string",
                "example":"/resources/assure1/images/icons/misc/BookSearch.png"
            },
            "ToolPath":{
                "description":"Path to launch the view tool. SQL tools do not have a path.",
                "type":"string",
                "example":"Knowledgebase.php?Action=Search;Type=Device;EventID=<EventID>"
            },
            "ToolPathTypeName":{
                "description":"Indicator for what type of view tool this is.\nAllowed values are local, hybrid, internal, remote.",
                "type":"string",
                "example":"Local"
            },
            "ContextID":{
                "example":"1"
            },
            "AugmentData":{
                "description":"Flag to indicate if the event information is available to the tool.",
                "type":"integer",
                "example":"1"
            },
            "Refresh":{
                "description":"Flag to indicate if the event list will be unpaused and refreshed when the tool finishes.",
                "type":"integer",
                "example":"0"
            },
            "ToolTarget":{
                "description":"How to handle the tool contents. Allowed values are newtab, window, or currenttab. Newtab opens the tool in a new browser tab. Currenttab opens the tool in the current tab. Window opens the tool in a new browser window.",
                "type":"string",
                "example":"window"
            },
            "Height":{
                "description":"Tool window height in pixels.",
                "type":"integer",
                "example":"600"
            },
            "Width":{
                "description":"Tool window width in pixels.",
                "type":"integer",
                "example":"800"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• AugmentData: integer
  Flag to indicate if the event information is available to the tool.

  Example: 1
• ContextID:
  Example: 1
• Height: integer
  Tool window height in pixels.

  Example: 600
• icon: string
  Path to the icon image to use in the menu.

  Example: /resources/assure1/images/icons/misc/BookSearch.png
• Refresh: integer
  Flag to indicate if the event list will be unpaused and refreshed when the tool finishes.

  Example: 0
• text: string
  Tool Name.

  Example: By Device
• ToolID: integer
  Menu tool ID.

  Example: 20
• ToolName: string
  Tool Name.

  Example: By Device
• ToolPath: string
  Path to launch the view tool. SQL tools do not have a path.

  Example: Knowledgebase.php?Action=Search;Type=Device;EventID=<EventID>
• ToolPathTypeName: string
  Indicator for what type of view tool this is. Allowed values are local, hybrid, internal, remote.

  Example: Local
• ToolTarget: string
  How to handle the tool contents. Allowed values are newtab, window, or currenttab. Newtab opens the tool in a new browser tab. Currenttab opens the tool in the current tab. Window opens the tool in a new browser window.

  Example: window
• ToolTypeName: string
  The tool type can be either "View" or "SQL".

  Example: View
• Width: integer
  Tool window width in pixels.

  Example: 800

{
    "type":"object",
    "properties":{
        "ToolID":{
            "description":"Menu tool ID.",
            "type":"integer",
            "example":"20"
        },
        "text":{
            "description":"Tool Name.",
            "type":"string",
            "example":"By Device"
        },
        "ToolName":{
            "description":"Tool Name.",
            "type":"string",
            "example":"By Device"
        },
        "ToolTypeName":{
            "description":"The tool type can be either \"View\" or \"SQL\".",
            "type":"string",
            "example":"View"
        },
        "icon":{
            "description":"Path to the icon image to use in the menu.",
            "type":"string",
            "example":"/resources/assure1/images/icons/misc/BookSearch.png"
        },
        "ToolPath":{
            "description":"Path to launch the view tool. SQL tools do not have a path.",
            "type":"string",
            "example":"Knowledgebase.php?Action=Search;Type=Device;EventID=<EventID>"
        },
        "ToolPathTypeName":{
            "description":"Indicator for what type of view tool this is.\nAllowed values are local, hybrid, internal, remote.",
            "type":"string",
            "example":"Local"
        },
        "ContextID":{
            "example":"1"
        },
        "AugmentData":{
            "description":"Flag to indicate if the event information is available to the tool.",
            "type":"integer",
            "example":"1"
        },
        "Refresh":{
            "description":"Flag to indicate if the event list will be unpaused and refreshed when the tool finishes.",
            "type":"integer",
            "example":"0"
        },
        "ToolTarget":{
            "description":"How to handle the tool contents. Allowed values are newtab, window, or currenttab. Newtab opens the tool in a new browser tab. Currenttab opens the tool in the current tab. Window opens the tool in a new browser window.",
            "type":"string",
            "example":"window"
        },
        "Height":{
            "description":"Tool window height in pixels.",
            "type":"integer",
            "example":"600"
        },
        "Width":{
            "description":"Tool window width in pixels.",
            "type":"integer",
            "example":"800"
        }
    }
}

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