Update a Diagram Menu
put
/api/diagram/Menus/{id}
Updates the diagram menu that matches the specified ID.
Request
Path Parameters
-
id(required): integer
The diagram menu ID specified for individual CRUD operations.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
MenuName: string
The new name of the menu. If specified, the name of the menu is updated with this new value.Example:
Device Info
-
ParentMenuID: integer
The parent menu ID. If specified, the menu is moved to this parent menu.Example:
1
-
Tools: array
Tools
The list of tool IDs. If specified, this set of menu tools is associated with the menu.
-
UserGroupID: integer
The user group ID. If specified, the API will give access to the user group with matching ID.Example:
1
Nested Schema : Tools
Type:
array
The list of tool IDs. If specified, this set of menu tools is associated with the menu.
Show Source
Example:
[
"2",
"1",
"3"
]
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 : type
Type:
Show Source
object
-
data: array
data
The properties of the updated diagram menu.
Nested Schema : data
Type:
array
The properties of the updated diagram menu.
Show Source
Example:
[
"2",
"1",
"3"
]
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.