Update an Event Menu
put
/api/event/Menus/{id}
Updates the properties of the event menu that matches the specified ID.
Request
Path Parameters
-
id(required): integer(int32)
The event menu ID.Example:
1
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
DefaultMenu: integer
Flag to indicate if this is the default menu or not.Example:
0
-
MenuName: string
The event menu name.
To avoid confusion with numeric IDs, the name value cannot be integers only or integers prefixed with the + or - symbols only. It must contain letters or other characters. For example, 1234, +1234, and -1234 are not valid, but US1234, US+1234 and US_1234 are.Example:Admin
-
Tools: array
Tools
List of Tool IDs
-
UserGroupID: integer
The user group ID.Example:
1
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulUpdateOperation
The response body for a successful update operation.
-
object
type
Nested Schema : SuccessfulUpdateOperation
Type:
object
The response body for a successful update operation.
Show Source
-
message: string
The response message.Example:
Updated record
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : data
Type:
array
The list of updated event menus.
Show Source
Example:
[
1,
2,
3,
4
]
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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.