Jump to

• Request
• Response

Get a Topology Menu by ID.

get

/api/topology/Menus/{id}

Gets the topology menu that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The menu ID.

  Example:

  1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
  The response body for a successful get operation.
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/topologyMenusRead_byID"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

The response body for a successful get operation.

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "description":"The response body for a successful get 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":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/topologyMenusRead_byID"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object topologyMenusRead_byID

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/topologyMenusRead_byID"
    }
}

Nested Schema : topologyMenusRead_byID

Type: object

Show Source

• ParentMenuID: integer
  Parent Menu ID

  Example: 1
• Tools: array Tools
  List of Tool IDs
• TopologyMenuID: integer
  Topology Menu ID

  Example: 2
• TopologyMenuName: string
  Topology Menu Name

  Example: Default Topology Tools
• TreeDepth: integer
  Indicator or how many levels deep the new parent menu is. TreeDepth is different than depth. TreeDepth is the number of menus above the current menu. This means TreeDepth will always be depth - 1.
• UserGroupID: object UserGroupID
  User Group ID

{
    "properties":{
        "TopologyMenuID":{
            "description":"Topology Menu ID",
            "type":"integer",
            "example":"2"
        },
        "TopologyMenuName":{
            "description":"Topology Menu Name",
            "type":"string",
            "example":"Default Topology Tools"
        },
        "UserGroupID":{
            "description":"User Group ID",
            "type":"object",
            "properties":{
                "id":{
                    "description":"ID of the User Group",
                    "type":"integer",
                    "example":"1"
                },
                "name":{
                    "description":"User Group Name",
                    "type":"string",
                    "example":"Administrators"
                }
            }
        },
        "ParentMenuID":{
            "description":"Parent Menu ID",
            "type":"integer",
            "example":"1"
        },
        "TreeDepth":{
            "description":"Indicator or how many levels deep the new parent menu is. TreeDepth is different than depth. TreeDepth is the number of menus above the current menu. This means TreeDepth will always be depth - 1.",
            "type":"integer"
        },
        "Tools":{
            "description":"List of Tool IDs",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "ToolID":{
                        "description":"Tool ID",
                        "type":"integer",
                        "example":"1"
                    },
                    "ToolName":{
                        "description":"Tool Name",
                        "type":"string",
                        "example":"Device Overview"
                    }
                }
            },
            "example":[
                {
                    "ToolID":"1",
                    "ToolName":"Device Overview"
                },
                {
                    "ToolID":"2",
                    "ToolName":"Events"
                }
            ]
        }
    },
    "type":"object"
}

Nested Schema : Tools

Type: array

List of Tool IDs

Show Source

• Array of: object items

{
    "description":"List of Tool IDs",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "ToolID":{
                "description":"Tool ID",
                "type":"integer",
                "example":"1"
            },
            "ToolName":{
                "description":"Tool Name",
                "type":"string",
                "example":"Device Overview"
            }
        }
    },
    "example":[
        {
            "ToolID":"1",
            "ToolName":"Device Overview"
        },
        {
            "ToolID":"2",
            "ToolName":"Events"
        }
    ]
}

Example:

[
    {
        "ToolID":"1",
        "ToolName":"Device Overview"
    },
    {
        "ToolID":"2",
        "ToolName":"Events"
    }
]

Nested Schema : UserGroupID

Type: object

User Group ID

Show Source

• id: integer
  ID of the User Group

  Example: 1
• name: string
  User Group Name

  Example: Administrators

{
    "description":"User Group ID",
    "type":"object",
    "properties":{
        "id":{
            "description":"ID of the User Group",
            "type":"integer",
            "example":"1"
        },
        "name":{
            "description":"User Group Name",
            "type":"string",
            "example":"Administrators"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• ToolID: integer
  Tool ID

  Example: 1
• ToolName: string
  Tool Name

  Example: Device Overview

{
    "type":"object",
    "properties":{
        "ToolID":{
            "description":"Tool ID",
            "type":"integer",
            "example":"1"
        },
        "ToolName":{
            "description":"Tool Name",
            "type":"string",
            "example":"Device Overview"
        }
    }
}

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