Jump to

• Request
• Response

Get Topology Menus for Tree Combos

get

/api/topology/Menus/readForTree

Gets topology menus in a format suitable for tree combos. Specify the id query parameter to get the entire tree from root to the menu with the specified ID. Specify the node parameter if you want to get the children for the menu with the specified ID.

Request

Query Parameters

• id: integer(int32)
  The menu ID to get the entire tree for, from the root to the menu with the specified ID.

  Example:

  1

• node: string
  The menu ID to get the children for.

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":{
                        "oneOf":[
                            {
                                "$ref":"#/components/schemas/topologyMenusReadForTreeNode"
                            },
                            {
                                "$ref":"#/components/schemas/topologyMenusReadForTreeID"
                            }
                        ]
                    }
                }
            }
        }
    ]
}

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":{
                "oneOf":[
                    {
                        "$ref":"#/components/schemas/topologyMenusReadForTreeNode"
                    },
                    {
                        "$ref":"#/components/schemas/topologyMenusReadForTreeID"
                    }
                ]
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: items

{
    "type":"array",
    "items":{
        "oneOf":[
            {
                "$ref":"#/components/schemas/topologyMenusReadForTreeNode"
            },
            {
                "$ref":"#/components/schemas/topologyMenusReadForTreeID"
            }
        ]
    }
}

Nested Schema : items

Match One Schema

Show Source

• object topologyMenusReadForTreeNode
• object topologyMenusReadForTreeID

{
    "oneOf":[
        {
            "$ref":"#/components/schemas/topologyMenusReadForTreeNode"
        },
        {
            "$ref":"#/components/schemas/topologyMenusReadForTreeID"
        }
    ]
}

Nested Schema : topologyMenusReadForTreeNode

Type: object

Show Source

• iconCls: string
  CSS class for icons.

  Example: x-tree-icon-parent
• leaf: boolean
  Leaf Node of the tree

  Example: false
• TopologyMenuID: integer
  Topology Menu ID

  Example: 1
• TopologyMenuName: string
  Display Name

  Example: Root

{
    "properties":{
        "TopologyMenuID":{
            "$ref":"#/components/schemas/topologyMenusRead/properties/TopologyMenuID"
        },
        "TopologyMenuName":{
            "$ref":"#/components/schemas/topologyMenusRead/properties/DisplayName"
        },
        "leaf":{
            "description":"Leaf Node of the tree",
            "type":"boolean",
            "example":false
        },
        "iconCls":{
            "description":"CSS class for icons.",
            "type":"string",
            "example":"x-tree-icon-parent"
        }
    },
    "type":"object"
}

Nested Schema : topologyMenusReadForTreeID

Type: object

Show Source

• data: object data
  Contains the next level of data in the same format as this one.
• depth: integer
  Indicator or how many levels deep this menu is. The root will always be 1
• expanded: boolean
  Indicates if the menu should be displayed expanded or collapsed.
• Lft: integer
  Index of the tree menu's left edge

  Example: 1
• path: string
  The path to this menu starting with the root.
• Rgt: integer
  Index of the tree menu's right edge

  Example: 2
• TopologyMenuID: integer
  Topology Menu ID

  Example: 1
• TopologyMenuName: string
  Display Name

  Example: Root
• UserGroupID: integer
  User group ID
• UserGroupName: string
  User group name

{
    "properties":{
        "TopologyMenuID":{
            "$ref":"#/components/schemas/topologyMenusRead/properties/TopologyMenuID"
        },
        "TopologyMenuName":{
            "$ref":"#/components/schemas/topologyMenusRead/properties/DisplayName"
        },
        "Lft":{
            "description":"Index of the tree menu's left edge",
            "type":"integer",
            "example":1
        },
        "Rgt":{
            "description":"Index of the tree menu's right edge",
            "type":"integer",
            "example":2
        },
        "UserGroupID":{
            "description":"User group ID",
            "type":"integer"
        },
        "UserGroupName":{
            "description":"User group name",
            "type":"string"
        },
        "path":{
            "description":"The path to this menu starting with the root.",
            "type":"string"
        },
        "depth":{
            "description":"Indicator or how many levels deep this menu is. The root will always be 1",
            "type":"integer"
        },
        "expanded":{
            "description":"Indicates if the menu should be displayed expanded or collapsed.",
            "type":"boolean"
        },
        "data":{
            "description":"Contains the next level of data in the same format as this one.",
            "type":"object"
        }
    },
    "type":"object"
}

Nested Schema : data

Type: object

Contains the next level of data in the same format as this one.

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