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

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

[comment]: # ({ea4b34b2-ebdc9145})
### Описание

`integer/array templatedashboard.get(параметры объекта)`

Метод позволяет получить шаблоны панелей мониторинга в соответствии с заданными параметрами.

::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::

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

[comment]: # ({be5a313d-4ba697bd})
### Параметры

`(object)` Параметры, определяющие требуемый результат.

Метод поддерживает следующие параметры.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Description|
|--|--|------|
|dashboardids|ID/array|Возвращать только шаблонные панели мониторинга с указанными ID.|
|templateids|ID/array|Возвращать только шаблонные панели мониторинга, принадлежащие указанным шаблонам.|
|selectPages|query|Возвращать свойство [`pages`](/manual/api/reference/templatedashboard/object#template-dashboard-page) с страницами шаблонной панели мониторинга, корректно упорядоченными.|
|sortfield|string/array|Сортировать результат по указанным свойствам.<br><br>Возможные значения: `dashboardid`, `name`.|
|countOutput|boolean|Эти параметры описаны в [справочном комментарии](/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]: # ({/be5a313d-4ba697bd})

[comment]: # ({7223bab1-7223bab1})
### Возвращаемые значения

`(целое число/массив)` Возвращает либо:

- · массив объектов;
- · количество извлеченных объектов, если использовался параметр `countOutput`.

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

[comment]: # ({b41637d2-b41637d2})
### Примеры

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

[comment]: # ({79bee683-62e5fb34})
#### Получение дашбордов шаблона

Получить все дашборды шаблона с виджетами для указанного шаблона.

[Запрос](/manual/api#performing-requests):

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

Ответ:

```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": "36",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "6",
                                    "name": "graphid",
                                    "value": "1125"
                                }
                            ]
                        },
                        {
                            "widgetid": "221",
                            "type": "graph",
                            "name": "",
                            "x": "12",
                            "y": "0",
                            "width": "36",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "6",
                                    "name": "graphid",
                                    "value": "1129"
                                }
                            ]
                        },
                        {
                            "widgetid": "222",
                            "type": "graph",
                            "name": "",
                            "x": "0",
                            "y": "5",
                            "width": "36",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "6",
                                    "name": "graphid",
                                    "value": "1128"
                                }
                            ]
                        },
                        {
                            "widgetid": "223",
                            "type": "graph",
                            "name": "",
                            "x": "12",
                            "y": "5",
                            "width": "36",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "6",
                                    "name": "graphid",
                                    "value": "1126"
                                }
                            ]
                        },
                        {
                            "widgetid": "224",
                            "type": "graph",
                            "name": "",
                            "x": "0",
                            "y": "10",
                            "width": "36",
                            "height": "5",
                            "view_mode": "0",
                            "fields": [
                                {
                                    "type": "6",
                                    "name": "graphid",
                                    "value": "1127"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ],
    "id": 1
}
```

[comment]: # ({/79bee683-62e5fb34})

[comment]: # ({930bd864-1171cc63})
### См. также

-   [Страница панели шаблона](object#template-dashboard-page)
-   [Виджет панели шаблона](object#template-dashboard-widget)
-   [Поле виджета панели шаблона](object#template-dashboard-widget-field)

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

[comment]: # ({ddadb6a1-ddadb6a1})
### Источник

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

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