Jump to

• Request
• Response

Get a Dashboard Group by ID

get

/api/dashboard/DashboardGroups/{id}

Gets the dashboard group that matches the specified ID.

Request

Path Parameters

• id(required): integer(int32)
  The dashboard group ID.

Query Parameters

• readChildren: boolean
  Whether to show tree display or form display. Allowed values - true -> Returns only children group information (for tree display). - false -> Returns the requested group information (for form display).

  Example:

  false

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":{
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID"
                    }
                }
            }
        }
    ]
}

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

{
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object dashboardDashboardGroupsReadByID

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/dashboardDashboardGroupsReadByID"
    }
}

Nested Schema : dashboardDashboardGroupsReadByID

Type: object

Show Source

• DashboardGroupID: integer
  Dashboard Group ID

  Example: 1
• DashboardGroupName: string
  Dashboard Group Name

  Example: Adhoc
• Dashboards: array Dashboards
  List of Dashboards IDs
• ParentDashboardGroupID: integer
  Dashboard Group Id of Parent

  Example: 1

{
    "type":"object",
    "properties":{
        "DashboardGroupID":{
            "description":"Dashboard Group ID",
            "type":"integer",
            "example":"1"
        },
        "DashboardGroupName":{
            "description":"Dashboard Group Name",
            "type":"string",
            "example":"Adhoc"
        },
        "ParentDashboardGroupID":{
            "description":"Dashboard Group Id of Parent",
            "type":"integer",
            "example":"1"
        },
        "Dashboards":{
            "description":"List of Dashboards IDs",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "DashboardID":{
                        "description":"The dashboard ID.",
                        "type":"integer"
                    },
                    "DashboardName":{
                        "description":"Dashboard Name",
                        "type":"string"
                    }
                }
            },
            "example":[
                {
                    "DashboardID":"27",
                    "DashboardName":"Adhoc Metric Dashboard"
                },
                {
                    "DashboardID":"28",
                    "DashboardName":"Adhoc Event Dashboard"
                },
                {
                    "DashboardID":"39",
                    "DashboardName":"Adhoc View Config Dashboard"
                },
                {
                    "DashboardID":"29",
                    "DashboardName":"Adhoc Graph Dashboard"
                }
            ]
        }
    }
}

Nested Schema : Dashboards

Type: array

List of Dashboards IDs

Show Source

• Array of: object items

{
    "description":"List of Dashboards IDs",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "DashboardID":{
                "description":"The dashboard ID.",
                "type":"integer"
            },
            "DashboardName":{
                "description":"Dashboard Name",
                "type":"string"
            }
        }
    },
    "example":[
        {
            "DashboardID":"27",
            "DashboardName":"Adhoc Metric Dashboard"
        },
        {
            "DashboardID":"28",
            "DashboardName":"Adhoc Event Dashboard"
        },
        {
            "DashboardID":"39",
            "DashboardName":"Adhoc View Config Dashboard"
        },
        {
            "DashboardID":"29",
            "DashboardName":"Adhoc Graph Dashboard"
        }
    ]
}

Example:

[
    {
        "DashboardID":"27",
        "DashboardName":"Adhoc Metric Dashboard"
    },
    {
        "DashboardID":"28",
        "DashboardName":"Adhoc Event Dashboard"
    },
    {
        "DashboardID":"39",
        "DashboardName":"Adhoc View Config Dashboard"
    },
    {
        "DashboardID":"29",
        "DashboardName":"Adhoc Graph Dashboard"
    }
]

Nested Schema : items

Type: object

Show Source

• DashboardID: integer
  The dashboard ID.
• DashboardName: string
  Dashboard Name

{
    "type":"object",
    "properties":{
        "DashboardID":{
            "description":"The dashboard ID.",
            "type":"integer"
        },
        "DashboardName":{
            "description":"Dashboard Name",
            "type":"string"
        }
    }
}

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