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 TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Nested Schema : SuccessfulGetOperation
Type:
Show Source
object
-
message: string
The response message.Example:
Loaded 1 entries
-
success: boolean
Whether the operation was a success (true) or a failure (false).Example:
true
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The list of link groups.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : linkLinkGroupsReadForTree
Type:
Show Source
object
-
data: array
data
List of LinkGroups
-
expanded: boolean
Expanded TreeExample:
true
-
iconCls: string
CSS class for the iconExample:
x-tree-icon-parent
-
leaf: boolean
Leaf or NotExample:
false
-
LinkGroupID: integer
Unique identifier for the Link Group.Example:
1
-
LinkGroupName: string
The name of the Link Group.Example:
Root
Nested Schema : data
Type:
array
List of LinkGroups
Show Source
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
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
Nested Schema : items
Type:
object