Get Diagram Groups for Tree Grids
get
/api/diagram/DiagramGroups/readForTree
Gets diagram groups in a format suitable for tree grids.
Request
Query Parameters
-
node(required): string
The node of the tree to get. You can specify root, the numerical ID, or the full tree path.Example:
root
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
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
Nested Schema : type
Type:
Show Source
object
-
data: array
data
The list of diagram groups.
-
total: integer
The total number of results regardless of paging.Example:
1
Nested Schema : diagramDiagramGroupsReadForTree
Type:
Show Source
object
-
DiagramGroupID: integer
The diagram group ID for individual CRUD operations.Example:
3
-
DiagramGroupName: string
The diagram group name.Example:
Test Group
-
iconCls: string
The CSS class for icons.Example:
x-tree-icon-parent
-
leaf: boolean
Whether it is a leaf node (true) or not (false).Example:
false
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
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.