Jump to

• Request
• Response

Create a Diagram Menu

post

/api/diagram/Menus

Creates a new diagram menu.

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
  Name of menu to be created.

  Example: Device Info
• ParentMenuID: integer
  Menu ID of parent.

  Example: 1
• Tools: array Tools
  List of tool IDs. If specified, the set of menu tools is associated with the menu.
• UserGroupID: integer
  ID of the User Group.

  Example: 1

{
    "type":"object",
    "properties":{
        "MenuName":{
            "description":"Name of menu to be created.",
            "type":"string",
            "example":"Device Info"
        },
        "ParentMenuID":{
            "description":"Menu ID of parent.",
            "type":"integer",
            "example":"1"
        },
        "Tools":{
            "description":"List of tool IDs. If specified, the set of menu tools is associated with the menu.",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                2,
                1,
                3
            ]
        },
        "UserGroupID":{
            "description":"ID of the User Group.",
            "type":"integer",
            "example":1
        }
    }
}

Nested Schema : Tools

Type: array

List of tool IDs. If specified, the set of menu tools is associated with the menu.

Show Source

• Array of: integer

{
    "description":"List of tool IDs. If specified, the 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
• 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

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

{
    "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":{
                "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

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

Nested Schema : items

Type: object

Back to Top