Update a Diagram Menu

put

/api/diagram/Menus/{id}

Updates the diagram menu that matches the specified ID.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • The new name of the menu. If specified, the name of the menu is updated with this new value.
    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: Device Info
  • The parent menu ID. If specified, the menu is moved to this parent menu.
    Example: 1
  • Tools
    The list of tool IDs. If specified, this set of menu tools is associated with the menu.
  • 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
]
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : schema
Match All
Show Source
Nested Schema : SuccessfulUpdateOperation
Type: object
The response body for a successful update operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: array
The properties of the updated diagram menu.
Show Source
Example:
[
    2,
    1,
    3
]

Default Response

Failed operation
Body ()
Root Schema : schema
Type: object
Show Source
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
An error.
Back to Top