[comment]: # ({f53ff4b2-f53ff4b2})
# templatedashboard.get

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

[comment]: # ({ea4b34b2-ebdc9145})
### Beschrijving

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

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

::: noteclassic
Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode te gebruiken kan worden ingetrokken in de gebruikersrolinstellingen. Zie [Gebruikersrollen](/manual/web_interface/frontend_sections/users/user_roles) voor meer informatie.
:::

[comment]: # ({/ea4b34b2-ebdc9145})

[comment]: # ({d716bf28-4ba697bd})
### 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|Alleen sjabloon-dashboards retourneren met de opgegeven IDs.|
|templateids|string/array|Alleen sjabloon-dashboards retourneren die behoren tot de opgegeven sjablonen.|
|selectPages|query|Een [pages](/manual/api/reference/templatedashboard/object#template_dashboard_page) eigenschap retourneren met sjabloon-dashboardpagina's, correct geordend.|
|sortfield|string/array|De resultaten sorteren op basis van de opgegeven eigenschappen.<br><br>Mogelijke waarden: `dashboardid`, `name`.|
|countOutput|boolean|Deze parameters, die gemeenschappelijk zijn voor alle `get`-methoden, worden in detail beschreven in de [referentie-opmerkingen](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/d716bf28-4ba697bd})

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

`(integer/array)` Retourneert ofwel:

- een reeks objecten;
- het aantal opgehaalde objecten, als de `countOutput` parameter heeft
    gebruikt.

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

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

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

[comment]: # ({7840244c-62e5fb34})
#### Sjabloon-dashboards ophalen

Haal alle sjabloon-dashboards op met widgets voor een opgegeven sjabloon.

[Request](/manual/api#performing-requests):

```json
{
    "jsonrpc": "2.0",
    "method": "templatedashboard.get",
    "params": {
        "output": "extend",
        "selectPages": "extend",
        "templateids": "10001"
    },
    "id": 1
}
```

Response:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "dashboardid": "23",
            "name": "Docker-overzicht",
            "templateid": "10001",
            "display_period": "30",
            "auto_start": "1",
            "uuid": "6dfcbe0bc5ad400ea9c1c2dd7649282f",
            "pages": [
                {
                    "dashboard_pageid": "1",
                    "name": "",
                    "display_period": "0",
                    "widgets": [
                        {
                            "widgetid": "220",
                            "type": "graph",
                            "name": "",
                            "x": "0",
                            "y": "0",
                            "width": "12",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "6",
                                    "name": "graphid",
                                    "value": "1125"
                                }
                            ]
                        },
                        {
                            "widgetid": "221",
                            "type": "graph",
                            "name": "",
                            "x": "12",
                            "y": "0",
                            "width": "12",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "6",
                                    "name": "graphid",
                                    "value": "1129"
                                }
                            ]
                        },
                        {
                            "widgetid": "222",
                            "type": "graph",
                            "name": "",
                            "x": "0",
                            "y": "5",
                            "width": "12",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "6",
                                    "name": "graphid",
                                    "value": "1128"
                                }
                            ]
                        },
                        {
                            "widgetid": "223",
                            "type": "graph",
                            "name": "",
                            "x": "12",
                            "y": "5",
                            "width": "12",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "6",
                                    "name": "graphid",
                                    "value": "1126"
                                }
                            ]
                        },
                        {
                            "widgetid": "224",
                            "type": "graph",
                            "name": "",
                            "x": "0",
                            "y": "10",
                            "width": "12",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "6",
                                    "name": "graphid",
                                    "value": "1127"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/7840244c-62e5fb34})

[comment]: # ({1171cc63-1171cc63})
### Zie ook

- [Sjabloon dashboardpagina](object#template_dashboard_page)
- [Template dashboard widget](object#template_dashboard_widget)
- [Sjabloon dashboard widget
    field](object#template_dashboard_widget_field)

[comment]: # ({/1171cc63-1171cc63})

[comment]: # ({ddadb6a1-ddadb6a1})
### Bron

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

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