[comment]: # aside: 4

[comment]: # translation:outdated

[comment]: # ({f7884974-f7884974})
# dashboard.get

[comment]: # ({/f7884974-f7884974})

[comment]: # ({29679c8d-8d36c9b5})
### Beschrijving

`integer/array dashboard.get(object parameters)`

Deze methode maakt het mogelijk om dashboards op te halen aan de hand van de opgegeven parameters.

::: noteclassic
Deze methode is beschikbaar voor gebruikers van elk type. Rechten
om de methode aan te roepen kunnen worden ingetrokken in de instellingen
voor gebruikersrollen. Zie [Gebruikersrollen](/manual/web_interface/frontend_sections/users/user_roles)
voor meer informatie.
:::

[comment]: # ({/29679c8d-8d36c9b5})

[comment]: # ({7b89db2e-342bbd26})
### Parameters

`(object)` Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

|Parameter|[Type](/manual/api/reference_commentary#data_types)|Beschrijving|
|--|--|------|
|dashboardids|string/array|Geeft alleen dashboards terug met de opgegeven ID's.|
|selectPages|query|Geeft een [pages](/manual/api/reference/dashboard/object#dashboard_page) eigenschap terug met dashboardpagina's, correct geordend.|
|selectUsers|query|Geeft een [users](/manual/api/reference/dashboard/object#dashboard_user) eigenschap terug met gebruikers waarmee het dashboard is gedeeld.|
|selectUserGroups|query|Geeft een [userGroups](/manual/api/reference/dashboard/object#dashboard_user_group) eigenschap terug met gebruikersgroepen waarmee het dashboard is gedeeld.|
|sortfield|string/array|Sorteer het resultaat op basis van de opgegeven eigenschappen.<br><br>Mogelijke waarden: `dashboardid`.|
|countOutput|boolean|Deze parameters, die gemeenschappelijk zijn voor alle `get` methoden, worden in detail beschreven op de [referentiecommentaar](/manual/api/reference_commentary#common_get_method_parameters) pagina.|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/7b89db2e-342bbd26})

[comment]: # ({7223bab1-7223bab1})
### Teruggegeven waarden

`(integer/array)` Geeft óf:

-   een array van objecten;
-   het aantal opgehaalde objecten, als de `countOutput` parameter is gebruikt.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({aa9a5ad3-b41637d2})
### Voorbeelden

[comment]: # ({/aa9a5ad3-b41637d2})

[comment]: # ({5ad0e765-84a10cd6})
#### Dashboard ophalen op basis van ID

Haal alle gegevens op over dashboards "1" en "2".

[Aanvraag](/manual/api#uitvoeren-van-aanvragen):

```json
{
    "jsonrpc": "2.0",
    "method": "dashboard.get",
    "params": {
        "output": "extend",
        "selectPages": "extend",
        "selectUsers": "extend",
        "selectUserGroups": "extend",
        "dashboardids": [
            "1",
            "2"
        ]
    },
    "id": 1
}
```

Reactie:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "dashboardid": "1",
            "name": "Dashboard",
            "userid": "1",
            "private": "0",
            "display_period": "30",
            "auto_start": "1",
            "users": [],
            "userGroups": [],
            "pages": [
                {
                    "dashboard_pageid": "1",
                    "name": "",
                    "display_period": "0",
                    "widgets": [
                        {
                            "widgetid": "9",
                            "type": "systeminfo",
                            "name": "",
                            "x": "12",
                            "y": "8",
                            "width": "12",
                            "height": "5",
                            "view_mode": "0",
                            "fields": []
                        },
                        {
                            "widgetid": "8",
                            "type": "problemsbysv",
                            "name": "",
                            "x": "12",
                            "y": "4",
                            "width": "12",
                            "height": "4",
                            "view_mode": "0",
                            "fields": []
                        },
                        {
                            "widgetid": "7",
                            "type": "problemhosts",
                            "name": "",
                            "x": "12",
                            "y": "0",
                            "width": "12",
                            "height": "4",
                            "view_mode": "0",
                            "fields": []
                        },
                        {
                            "widgetid": "6",
                            "type": "discovery",
                            "name": "",
                            "x": "6",
                            "y": "9",
                            "width": "6",
                            "height": "4",
                            "view_mode": "0",
                            "fields": []
                        },
                        {
                            "widgetid": "5",
                            "type": "web",
                            "name": "",
                            "x": "0",
                            "y": "9",
                            "width": "6",
                            "height": "4",
                            "view_mode": "0",
                            "fields": []
                        },
                        {
                            "widgetid": "4",
                            "type": "problems",
                            "name": "",
                            "x": "0",
                            "y": "3",
                            "width": "12",
                            "height": "6",
                            "view_mode": "0",
                            "fields": []
                        },
                        {
                            "widgetid": "3",
                            "type": "favmaps",
                            "name": "",
                            "x": "8",
                            "y": "0",
                            "width": "4",
                            "height": "3",
                            "view_mode": "0",
                            "fields": []
                        },
                        {
                            "widgetid": "1",
                            "type": "favgraphs",
                            "name": "",
                            "x": "0",
                            "y": "0",
                            "width": "4",
                            "height": "3",
                            "view_mode": "0",
                            "fields": []
                        }
                    ]
                },
                {
                    "dashboard_pageid": "2",
                    "name": "",
                    "display_period": "0",
                    "widgets": []
                },
                {
                    "dashboard_pageid": "3",
                    "name": "Aangepaste paginanaam",
                    "display_period": "60",
                    "widgets": []
                }
            ]
        },
        {
            "dashboardid": "2",
            "name": "Mijn dashboard",
            "userid": "1",
            "private": "1",
            "display_period": "60",
            "auto_start": "1",
            "users": [
                {
                    "userid": "4",
                    "permission": "3"
                }
            ],
            "userGroups": [
                {
                    "usrgrpid": "7",
                    "permission": "2"
                }
            ],
            "pages": [
                {
                    "dashboard_pageid": "4",
                    "name": "",
                    "display_period": "0",
                    "widgets": [
                        {
                            "widgetid": "10",
                            "type": "problems",
                            "name": "",
                            "x": "0",
                            "y": "0",
                            "width": "12",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "2",
                                    "name": "groupids",
                                    "value": "4"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/5ad0e765-84a10cd6})

[comment]: # ({299ae089-299ae089})
### Zie ook

-   [Dashboardpagina](object#dashboard_page)
-   [Dashboardwidget](object#dashboard_widget)
-   [Dashboardwidgetveld](object#dashboard_widget_field)
-   [Dashboardgebruiker](object#dashboard_user)
-   [Dashboardgebruikersgroep](object#dashboard_user_group)

[comment]: # ({/299ae089-299ae089})

[comment]: # ({195ec9dd-75a9042e})
### Bron

CDashboard::get() in *ui/include/classes/api/services/CDashboard.php*.

[comment]: # ({/195ec9dd-75a9042e})