Jump to

• Request
• Response

Get Link Groups for Tree Grids

get

/api/link/LinkGroups/readForTree

Gets link groups in a format suitable for tree grids.

Request

Query Parameters

• node(required): string
  The node of the tree to get. It can be root or LinkGroupID.

  Example:

  root

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":{
                "total":{
                    "description":"The total number of results regardless of paging.",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "description":"The list of link groups.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/linkLinkGroupsReadForTree"
                    }
                }
            }
        }
    ]
}

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
  The list of link groups.
• total: integer
  The total number of results regardless of paging.

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging.",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"The list of link groups.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/linkLinkGroupsReadForTree"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of link groups.

Show Source

• Array of: object linkLinkGroupsReadForTree

{
    "description":"The list of link groups.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/linkLinkGroupsReadForTree"
    }
}

Nested Schema : linkLinkGroupsReadForTree

Type: object

Show Source

• data: array data
  List of LinkGroups
• expanded: boolean
  Expanded Tree

  Example: true
• iconCls: string
  CSS class for the icon

  Example: x-tree-icon-parent
• leaf: boolean
  Leaf or Not

  Example: false
• LinkGroupID: integer
  Unique identifier for the Link Group.

  Example: 1
• LinkGroupName: string
  The name of the Link Group.

  Example: Root

{
    "type":"object",
    "properties":{
        "LinkGroupID":{
            "description":"Unique identifier for the Link Group.",
            "type":"integer",
            "example":1
        },
        "LinkGroupName":{
            "description":"The name of the Link Group.",
            "type":"string",
            "example":"Root"
        },
        "leaf":{
            "description":"Leaf or Not",
            "type":"boolean",
            "example":false
        },
        "iconCls":{
            "description":"CSS class for the icon",
            "type":"string",
            "example":"x-tree-icon-parent"
        },
        "expanded":{
            "description":"Expanded Tree",
            "type":"boolean",
            "example":true
        },
        "data":{
            "description":"List of LinkGroups",
            "type":"array",
            "items":{
                "type":"object"
            },
            "example":[
                {
                    "LinkGroupID":"2",
                    "LinkGroupName":"Public",
                    "leaf":true,
                    "iconCls":"x-tree-icon-parent"
                },
                {
                    "LinkGroupID":"3",
                    "LinkGroupName":"Operators",
                    "leaf":true,
                    "iconCls":"x-tree-icon-parent"
                },
                {
                    "LinkGroupID":"4",
                    "LinkGroupName":"Admin",
                    "leaf":true,
                    "iconCls":"x-tree-icon-parent"
                }
            ]
        }
    }
}

Nested Schema : data

Type: array

List of LinkGroups

Show Source

• Array of: object items

{
    "description":"List of LinkGroups",
    "type":"array",
    "items":{
        "type":"object"
    },
    "example":[
        {
            "LinkGroupID":"2",
            "LinkGroupName":"Public",
            "leaf":true,
            "iconCls":"x-tree-icon-parent"
        },
        {
            "LinkGroupID":"3",
            "LinkGroupName":"Operators",
            "leaf":true,
            "iconCls":"x-tree-icon-parent"
        },
        {
            "LinkGroupID":"4",
            "LinkGroupName":"Admin",
            "leaf":true,
            "iconCls":"x-tree-icon-parent"
        }
    ]
}

Example:

[
    {
        "LinkGroupID":"2",
        "LinkGroupName":"Public",
        "leaf":true,
        "iconCls":"x-tree-icon-parent"
    },
    {
        "LinkGroupID":"3",
        "LinkGroupName":"Operators",
        "leaf":true,
        "iconCls":"x-tree-icon-parent"
    },
    {
        "LinkGroupID":"4",
        "LinkGroupName":"Admin",
        "leaf":true,
        "iconCls":"x-tree-icon-parent"
    }
]

Nested Schema : items

Type: object

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