Create a Diagram Menu

post

/api/diagram/Menus

Creates a new diagram menu.
The minimum required properties in the request body are:
  • MenuName
  • UserGroupID
  • ParentMenuID
  • Tools

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • The name of the menu to create.
    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.
    Example: 1
  • Tools
    The list of tool IDs. If specified, this set of menu tools is associated with the menu.
  • The user group 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 : SuccessfulAddOperation
Type: object
The response body for a successful add operation.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : data
Type: object
The properties of the new diagram menu.
Example:
{
    "id":6
}

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