Jump to

• Request
• Response

Get Dashboards and Dashboard Groups Under a Specific Node

get

/api/dashboardNavigation/Dashboards/readForTree

Gets dashboards and dashboard groups under a specific node.

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 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 dashboards and dashboard groups.",
                    "type":"array",
                    "items":{
                        "allOf":[
                            {
                                "type":"object",
                                "properties":{
                                    "id":{
                                        "description":"The dashboard ID.",
                                        "type":"integer"
                                    },
                                    "DashboardGroupID":{
                                        "description":"The dashboard group ID.",
                                        "type":"integer"
                                    },
                                    "text":{
                                        "description":"The name of the dashboard group or dashboard.",
                                        "type":"string"
                                    },
                                    "expanded":{
                                        "description":"Whether expanded or not.",
                                        "type":"boolean"
                                    }
                                }
                            },
                            {
                                "type":"object",
                                "properties":{
                                    "text":{
                                        "description":"The name of the dashboard group or dashboard.",
                                        "type":"string"
                                    },
                                    "leaf":{
                                        "description":"Indicates whether this is a leaf node in a hierarchy or not.",
                                        "type":"boolean"
                                    },
                                    "iconCls":{
                                        "description":"The CSS class for icons.",
                                        "type":"string"
                                    },
                                    "view":{
                                        "description":"The REST path to load the dashboard.",
                                        "type":"string"
                                    },
                                    "DashboardID":{
                                        "description":"The dashboard ID.",
                                        "type":"integer"
                                    },
                                    "DashboardName":{
                                        "description":"The dashboard name.",
                                        "type":"string"
                                    }
                                }
                            }
                        ]
                    },
                    "example":[
                        {
                            "id":"1002",
                            "DashboardGroupID":"1002",
                            "text":"Adhoc - Copy",
                            "expanded":false
                        },
                        {
                            "text":"Adhoc Event Dashboard",
                            "leaf":true,
                            "iconCls":"icon-portal",
                            "view":"#event/events/eventsAdhocView",
                            "DashboardID":"28",
                            "DashboardName":"Adhoc Event Dashboard"
                        }
                    ]
                }
            }
        }
    ]
}

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 dashboards and 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 dashboards and dashboard groups.",
            "type":"array",
            "items":{
                "allOf":[
                    {
                        "type":"object",
                        "properties":{
                            "id":{
                                "description":"The dashboard ID.",
                                "type":"integer"
                            },
                            "DashboardGroupID":{
                                "description":"The dashboard group ID.",
                                "type":"integer"
                            },
                            "text":{
                                "description":"The name of the dashboard group or dashboard.",
                                "type":"string"
                            },
                            "expanded":{
                                "description":"Whether expanded or not.",
                                "type":"boolean"
                            }
                        }
                    },
                    {
                        "type":"object",
                        "properties":{
                            "text":{
                                "description":"The name of the dashboard group or dashboard.",
                                "type":"string"
                            },
                            "leaf":{
                                "description":"Indicates whether this is a leaf node in a hierarchy or not.",
                                "type":"boolean"
                            },
                            "iconCls":{
                                "description":"The CSS class for icons.",
                                "type":"string"
                            },
                            "view":{
                                "description":"The REST path to load the dashboard.",
                                "type":"string"
                            },
                            "DashboardID":{
                                "description":"The dashboard ID.",
                                "type":"integer"
                            },
                            "DashboardName":{
                                "description":"The dashboard name.",
                                "type":"string"
                            }
                        }
                    }
                ]
            },
            "example":[
                {
                    "id":"1002",
                    "DashboardGroupID":"1002",
                    "text":"Adhoc - Copy",
                    "expanded":false
                },
                {
                    "text":"Adhoc Event Dashboard",
                    "leaf":true,
                    "iconCls":"icon-portal",
                    "view":"#event/events/eventsAdhocView",
                    "DashboardID":"28",
                    "DashboardName":"Adhoc Event Dashboard"
                }
            ]
        }
    }
}

Nested Schema : data

Type: array

The list of dashboards and dashboard groups.

Show Source

• Array of: items

{
    "description":"The list of dashboards and dashboard groups.",
    "type":"array",
    "items":{
        "allOf":[
            {
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The dashboard ID.",
                        "type":"integer"
                    },
                    "DashboardGroupID":{
                        "description":"The dashboard group ID.",
                        "type":"integer"
                    },
                    "text":{
                        "description":"The name of the dashboard group or dashboard.",
                        "type":"string"
                    },
                    "expanded":{
                        "description":"Whether expanded or not.",
                        "type":"boolean"
                    }
                }
            },
            {
                "type":"object",
                "properties":{
                    "text":{
                        "description":"The name of the dashboard group or dashboard.",
                        "type":"string"
                    },
                    "leaf":{
                        "description":"Indicates whether this is a leaf node in a hierarchy or not.",
                        "type":"boolean"
                    },
                    "iconCls":{
                        "description":"The CSS class for icons.",
                        "type":"string"
                    },
                    "view":{
                        "description":"The REST path to load the dashboard.",
                        "type":"string"
                    },
                    "DashboardID":{
                        "description":"The dashboard ID.",
                        "type":"integer"
                    },
                    "DashboardName":{
                        "description":"The dashboard name.",
                        "type":"string"
                    }
                }
            }
        ]
    },
    "example":[
        {
            "id":"1002",
            "DashboardGroupID":"1002",
            "text":"Adhoc - Copy",
            "expanded":false
        },
        {
            "text":"Adhoc Event Dashboard",
            "leaf":true,
            "iconCls":"icon-portal",
            "view":"#event/events/eventsAdhocView",
            "DashboardID":"28",
            "DashboardName":"Adhoc Event Dashboard"
        }
    ]
}

Example:

[
    {
        "id":"1002",
        "DashboardGroupID":"1002",
        "text":"Adhoc - Copy",
        "expanded":false
    },
    {
        "text":"Adhoc Event Dashboard",
        "leaf":true,
        "iconCls":"icon-portal",
        "view":"#event/events/eventsAdhocView",
        "DashboardID":"28",
        "DashboardName":"Adhoc Event Dashboard"
    }
]

Nested Schema : items

Match All

Show Source

• object type
• object type

{
    "allOf":[
        {
            "type":"object",
            "properties":{
                "id":{
                    "description":"The dashboard ID.",
                    "type":"integer"
                },
                "DashboardGroupID":{
                    "description":"The dashboard group ID.",
                    "type":"integer"
                },
                "text":{
                    "description":"The name of the dashboard group or dashboard.",
                    "type":"string"
                },
                "expanded":{
                    "description":"Whether expanded or not.",
                    "type":"boolean"
                }
            }
        },
        {
            "type":"object",
            "properties":{
                "text":{
                    "description":"The name of the dashboard group or dashboard.",
                    "type":"string"
                },
                "leaf":{
                    "description":"Indicates whether this is a leaf node in a hierarchy or not.",
                    "type":"boolean"
                },
                "iconCls":{
                    "description":"The CSS class for icons.",
                    "type":"string"
                },
                "view":{
                    "description":"The REST path to load the dashboard.",
                    "type":"string"
                },
                "DashboardID":{
                    "description":"The dashboard ID.",
                    "type":"integer"
                },
                "DashboardName":{
                    "description":"The dashboard name.",
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : type

Type: object

Show Source

• DashboardGroupID: integer
  The dashboard group ID.
• expanded: boolean
  Whether expanded or not.
• id: integer
  The dashboard ID.
• text: string
  The name of the dashboard group or dashboard.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The dashboard ID.",
            "type":"integer"
        },
        "DashboardGroupID":{
            "description":"The dashboard group ID.",
            "type":"integer"
        },
        "text":{
            "description":"The name of the dashboard group or dashboard.",
            "type":"string"
        },
        "expanded":{
            "description":"Whether expanded or not.",
            "type":"boolean"
        }
    }
}

Nested Schema : type

Type: object

Show Source

• DashboardID: integer
  The dashboard ID.
• DashboardName: string
  The dashboard name.
• iconCls: string
  The CSS class for icons.
• leaf: boolean
  Indicates whether this is a leaf node in a hierarchy or not.
• text: string
  The name of the dashboard group or dashboard.
• view: string
  The REST path to load the dashboard.

{
    "type":"object",
    "properties":{
        "text":{
            "description":"The name of the dashboard group or dashboard.",
            "type":"string"
        },
        "leaf":{
            "description":"Indicates whether this is a leaf node in a hierarchy or not.",
            "type":"boolean"
        },
        "iconCls":{
            "description":"The CSS class for icons.",
            "type":"string"
        },
        "view":{
            "description":"The REST path to load the dashboard.",
            "type":"string"
        },
        "DashboardID":{
            "description":"The dashboard ID.",
            "type":"integer"
        },
        "DashboardName":{
            "description":"The 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":{
                "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