Jump to

• Request
• Response

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

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• MenuName: string
  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
• ParentMenuID: integer
  The parent menu ID.

  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.

  Example: 1

{
    "type":"object",
    "properties":{
        "MenuName":{
            "description":"The name of the menu to create.\n<br>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, <b>1234</b>, <b>+1234</b>, and <b>-1234</b> are not valid, but <b>US1234</b>, <b>US+1234</b> and <b>US_1234</b> are.",
            "type":"string",
            "example":"Device Info"
        },
        "ParentMenuID":{
            "description":"The parent menu ID.",
            "type":"integer",
            "example":"1"
        },
        "Tools":{
            "description":"The list of tool IDs. If specified, this set of menu tools is associated with the menu.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                2,
                1,
                3
            ]
        },
        "UserGroupID":{
            "description":"The user group ID.",
            "type":"integer",
            "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

• Array of: integer

{
    "description":"The list of tool IDs. If specified, this set of menu tools is associated with the menu.",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        2,
        1,
        3
    ]
}

Example:

[
    2,
    1,
    3
]

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulAddOperation
  The response body for a successful add operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulAddOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "description":"The properties of the new diagram menu.",
                    "type":"object",
                    "example":{
                        "id":6
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulAddOperation

Type: object

The response body for a successful add operation.

Show Source

• message: string
  The response message.

  Example: Added record
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful add operation.",
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Added record"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: object data
  The properties of the new diagram menu.

{
    "type":"object",
    "properties":{
        "data":{
            "description":"The properties of the new diagram menu.",
            "type":"object",
            "example":{
                "id":6
            }
        }
    }
}

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

• 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

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "description":"An error.",
                "type":"object"
            }
        }
    },
    "type":"object"
}

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.

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "description":"An error.",
        "type":"object"
    }
}

Nested Schema : items

Type: object

An error.

Back to Top