Jump to

• Request
• Response

Get Dashboard Groups for Tree Grids or Form Grids

get

/api/dashboard/DashboardGroups

Gets the dashboard groups for the tree grid or the form grid.

Request

Query Parameters

• node(required): string
  The node of the tree to get. You can specify root or the numerical ID.

  Example:

  root

• sort: object
  The field and direction to sort results by. You cannot sort by fields that contain a state.
  This parameters value uses the following JSON format:
  {
  "property": "property",
  "direction": "direction"
  }

  • direction(required): string
    Allowed Values: [ "ASC", "DESC" ]

    The direction of the sort.

    Example: ASC
  • property(required): string
    The field to sort on.

    Example: name

  {
      "required":[
          "property",
          "direction"
      ],
      "properties":{
          "property":{
              "description":"The field to sort on.",
              "type":"string",
              "example":"name"
          },
          "direction":{
              "description":"The direction of the sort.",
              "type":"string",
              "enum":[
                  "ASC",
                  "DESC"
              ],
              "example":"ASC"
          }
      },
      "type":"object"
  }

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
• 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 dashboard groups.",
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/dashboardDashboardGroupsRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

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

{
    "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 dashboard 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 dashboard groups.",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/dashboardDashboardGroupsRead"
            }
        }
    }
}

Nested Schema : data

Type: array

The list of dashboard groups.

Show Source

• Array of: object dashboardDashboardGroupsRead

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

Nested Schema : dashboardDashboardGroupsRead

Type: object

Show Source

• cls: string
  Example: folder
• DashboardGroupID: integer
  Dashboard Group ID

  Example: 1
• DashboardGroupName: string
  Dashboard Group Name

  Example: Root
• data: array data
  List of children Dashboard Group
• ParentDashboardGroupID: integer
  Dashboard Group Id of Parent

  Example: 1
• total: integer
  Total number of children

  Example: 1

{
    "type":"object",
    "properties":{
        "DashboardGroupID":{
            "description":"Dashboard Group ID",
            "type":"integer",
            "example":"1"
        },
        "DashboardGroupName":{
            "description":"Dashboard Group Name",
            "type":"string",
            "example":"Root"
        },
        "ParentDashboardGroupID":{
            "description":"Dashboard Group Id of Parent",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "description":"List of children Dashboard Group",
            "type":"array",
            "items":{
                "type":"object"
            },
            "example":[
                {
                    "DashboardGroupID":"1000",
                    "DashboardGroupName":"Adhoc",
                    "ParentDashboardGroupID":"1",
                    "cls":"folder"
                }
            ]
        },
        "cls":{
            "type":"string",
            "example":"folder"
        },
        "total":{
            "description":"Total number of children",
            "type":"integer",
            "example":1
        }
    }
}

Nested Schema : data

Type: array

List of children Dashboard Group

Show Source

• Array of: object items

{
    "description":"List of children Dashboard Group",
    "type":"array",
    "items":{
        "type":"object"
    },
    "example":[
        {
            "DashboardGroupID":"1000",
            "DashboardGroupName":"Adhoc",
            "ParentDashboardGroupID":"1",
            "cls":"folder"
        }
    ]
}

Example:

[
    {
        "DashboardGroupID":"1000",
        "DashboardGroupName":"Adhoc",
        "ParentDashboardGroupID":"1",
        "cls":"folder"
    }
]

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":{
                "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

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top