[comment]: # ({6d5ea9cd-6d5ea9cd})
# templatedashboard.update

[comment]: # ({/6d5ea9cd-6d5ea9cd})

[comment]: # ({e82cca7f-3db870df})
### Описание

`object templatedashboard.update(объект/массив templateDashboards)`

Этот метод позволяет обновлять существующие шаблоны информационных панелей.

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

[comment]: # ({/e82cca7f-3db870df})

[comment]: # ({d6006aad-051bc982})
### Параметры

`(object/array)` Свойства шаблона панели, которые необходимо обновить.

Свойство `dashboardid` должно быть указано для каждой панели, все
остальные свойства являются необязательными. Будут
обновлены только указанные свойства.

В дополнение к [стандартным свойствам шаблона
панели](object#template-dashboard), метод принимает следующие
параметры.

|Параметр|[Type](/manual/api/reference_commentary#data-types)|Описание|
|--|--|------|
|pages|array|[Страницы шаблона панели](object#template-dashboard-page) для замены существующих страниц панели.<br><br>Страницы панели обновляются по свойству `dashboard_pageid`. Для объектов без свойства `dashboard_pageid` будут созданы новые страницы панели, а существующие страницы панели будут удалены, если не будут использованы повторно. Страницы панели будут упорядочены в том же порядке, в котором они указаны. Будут обновлены только указанные свойства страниц панели. Для свойства `pages` требуется как минимум один объект страницы панели.|

[comment]: # ({/d6006aad-051bc982})

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

`(object)` Возвращает объект, содержащий идентификаторы обновлённых панелей шаблона в свойстве `dashboardids`.

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

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

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

[comment]: # ({7e85dec3-7b6290ef})
#### Переименование дашборда шаблона

Переименуйте дашборд шаблона в "Performance graphs".

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

```json
{
    "jsonrpc": "2.0",
    "method": "templatedashboard.update",
    "params": {
        "dashboardid": "23",
        "name": "Performance graphs"
    },
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "23"
        ]
    },
    "id": 1
}
```

[comment]: # ({/7e85dec3-7b6290ef})

[comment]: # ({12c7c5a0-cf0dcd1e})
#### Обновление страниц панели шаблона

Переименуйте первую страницу панели, замените виджеты на второй странице
панели и добавьте новую страницу в качестве третьей. Удалите все остальные
страницы панели.

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

```json
{
    "jsonrpc": "2.0",
    "method": "templatedashboard.update",
    "params": {
        "dashboardid": "2",
        "pages": [
            {
                "dashboard_pageid": 1,
                "name": "Переименованная страница"
            },
            {
                "dashboard_pageid": 2,
                "widgets": [
                    {
                        "type": "clock",
                        "x": 0,
                        "y": 0,
                        "width": 12,
                        "height": 3
                    }
                ]
            },
            {
                "display_period": 60
            }
        ]
    },
    "id": 1
}
```

Ответ:

```json
{
    "jsonrpc": "2.0",
    "result": {
        "dashboardids": [
            "2"
        ]
    },
    "id": 1
}
```

[comment]: # ({/12c7c5a0-cf0dcd1e})

[comment]: # ({7b2285ce-24de180a})
### См. также

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

[comment]: # ({/7b2285ce-24de180a})

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

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

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