Get Event Menus
get
/api/event/Menus
Gets the event menus from a node.
Request
Query Parameters
-
node(required): string
The node specifies the event menu to retrieve. You can either get all event menus by specifying root or get a particular menu by specifying the menu ID.Example:
root
-
sort: object
The field and direction to sort results by. You cannot sort by fields that contain a state.
This parameters value uses the following JSON format:
{
"property": "property",
"direction": "direction"
}-
direction(required):
string
Allowed Values:
[ "ASC", "DESC" ]
The direction of the sort.Example:ASC
-
property(required):
string
The field to sort on.Example:
name
-
direction(required):
string
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 : type
Type:
Show Source
object
-
data: array
data
The list of event menus.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : eventMenusRead
Type:
Show Source
object
-
cls: string
Class for the UI decoration.Example:
folder
-
DisplayName: string
Name of event menu.Example:
Global
-
MenuID: integer
Event menu IDExample:
1
-
ParentMenuID: integer
Menu ID for the parent group.Example:
2
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