[comment]: # translation:outdated

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

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

[comment]: # ({ebdc9145-ebdc9145})
### Descrição

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

O método permite recuperar painéis de modelo de acordo com os parâmetros
fornecidos.

::: noteclassic
Este método está disponível para usuários de qualquer tipo. As permissões
para chamar o método podem ser revogadas nas configurações de função do usuário. Consulte [Funções
do usuário](/manual/web_interface/frontend_sections/administration/user_roles)
para obter mais informações.
:::

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

[comment]: # ({919a5107-4ba697bd})
### Parâmetros

`(object)` Parâmetros que definem a saída desejada.

O método suporta os seguintes parâmetros.

|Parâmetro|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|dashboardids|string/array|Retorne apenas painéis de modelo com os IDs fornecidos.|
|templateids|string/array|Retorne apenas os painéis de modelo que pertencem aos modelos fornecidos.|
|selectPages|query|	Retorne uma propriedade de [páginas](/manual/api/reference/templatedashboard/object#template_dashboard_page) com páginas de painel de modelo, ordenadas corretamente.|
|sortfield|string/array|Classifique o resultado pelas propriedades fornecidas.<br><br>Os valores possíveis são: `dashboardid` and `name`.|
|countOutput|boolean|Esses parâmetros sendo comuns para todos os `get` métodos são descritos em detalhes no [comentário de referência](/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]: # ({/919a5107-4ba697bd})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno

`(inteiro/array)` Retorna:

- uma matriz de objetos;
- a contagem de objetos recuperados, se o parâmetro `countOutput` tiver
    sido usado.

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

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

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

[comment]: # ({ddc90296-62e5fb34})
#### Recuperando painéis de modelo

Recupere todos os painéis de modelo com widgets para um modelo especificado.
Requisição:

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

Resposta:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "dashboardid": "23",
            "name": "Docker overview",
            "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]: # ({/ddc90296-62e5fb34})

[comment]: # ({1171cc63-1171cc63})
### Veja também

-   [Página de template para dashboards](object#template_dashboard_page)
-   [Widget de template para dashboards](object#template_dashboard_widget)
-   [Campo widget para template dashboard
    ](object#template_dashboard_widget_field)

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

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

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

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