Move or Copy Diagram Tools to a New Menu
put
/api/diagram/Menus/updateTools
Moves or copies diagram tools to a new menu. To move, specify a source menu in SourceMenuID. To copy, do not specify a source menu.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
id: integer
The ID of the destination menu.Example:
4
-
SourceMenuID: integer
The ID of the source menu. To move tools, specify an ID. To copy tools, do not use this parameter.
-
Tools: array
Tools
The list of tool IDs to move or copy.
Nested Schema : Tools
Type:
array
The list of tool IDs to move or copy.
Show Source
Example:
[
1,
2,
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 destination diagram menu with the moved or copied menu tools.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : data
Type:
array
The destination diagram menu with the moved or copied menu tools.
Show Source
Nested Schema : diagramMenusReadByID
Type:
Show Source
object
-
MenuName: string
The menu name.Example:
Device Info
-
ParentMenuID: integer
The parent menu ID.Example:
1
-
Tools: object
Tools
The list of tool IDs.
-
UserGroupID: object
UserGroupID
The user group ID.
Nested Schema : Tools
Type:
object
The list of tool IDs.
Show Source
-
ToolID: integer
The tool ID.Example:
2
-
ToolName: string
The tool name.Example:
Device Health
Example:
[
{
"ToolID":"2",
"ToolName":"Device Health"
},
{
"ToolID":"1",
"ToolName":"Manage Device"
},
{
"ToolID":"3",
"ToolName":"Network Details"
}
]
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.