REST API for Unified Assurance Core

Create a Menu

post

/api/topology/Menus

Creates a topology menu.
The minimum required properties in the request body are:

TopologyMenuName
ParentMenuID
Tools

Request

There are no request parameters for this operation.

Supported Media Types

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

The topology menu name.
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: Default Topology Tools

{
    "properties":{
        "TopologyMenuName":{
            "description":"The topology menu name.\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":"Default Topology Tools"
        },
        "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:

Response

Supported Media Types

application/json

200 Response

Successful operation

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

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

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

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.