Jump to

• Request
• Response

Create a Menu

post

/api/topology/Menus

Creates a 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

• ParentMenuID: integer
  Parent Menu ID

  Example: 1
• Tools: array Tools
  List of Tool IDs
• TopologyMenuName: string
  Topology Menu Name

  Example: Default Topology Tools

{
    "properties":{
        "TopologyMenuName":{
            "$ref":"#/components/schemas/topologyMenusRead_byID/properties/TopologyMenuName"
        },
        "ParentMenuID":{
            "$ref":"#/components/schemas/topologyMenusRead_byID/properties/ParentMenuID"
        },
        "Tools":{
            "description":"List of Tool IDs",
            "type":"array",
            "items":{
                "type":"integer"
            },
            "example":[
                1,
                2,
                3,
                4,
                5
            ]
        }
    },
    "type":"object"
}

Nested Schema : Tools

Type: array

List of Tool IDs

Show Source

• Array of: integer

{
    "description":"List of Tool IDs",
    "type":"array",
    "items":{
        "type":"integer"
    },
    "example":[
        1,
        2,
        3,
        4,
        5
    ]
}

Example:

[
    1,
    2,
    3,
    4,
    5
]

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":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "description":"The menu ID.",
                            "type":"integer",
                            "example":"2"
                        }
                    }
                }
            }
        }
    ]
}

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

{
    "type":"object",
    "properties":{
        "data":{
            "type":"object",
            "properties":{
                "id":{
                    "description":"The menu ID.",
                    "type":"integer",
                    "example":"2"
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Show Source

• id: integer
  The menu ID.

  Example: 2

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The menu ID.",
            "type":"integer",
            "example":"2"
        }
    }
}

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