[comment]: # aside: 5

[comment]: # ({66fb9690-66fb9690})
# dashboard.update

[comment]: # ({/66fb9690-66fb9690})

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

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

Этот метод позволяет обновлять существующие панели.

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

[comment]: # ({/becba6de-f235159f})

[comment]: # ({bf54b1f0-62947aa0})
### Параметры

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

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

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

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

[comment]: # ({/bf54b1f0-62947aa0})

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

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

[comment]: # ({/28e89b38-28e89b38})

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

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

[comment]: # ({d0eb0276-7fcf7de4})
#### Переименование панели мониторинга

Переименуйте панель мониторинга в "SQL server status".

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

```json
{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "name": "SQL server status"
    },
    "id": 1
}
```

Ответ:

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

[comment]: # ({/d0eb0276-7fcf7de4})

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

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

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

```json
{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "pages": [
            {
                "dashboard_pageid": 1,
                "name": "Renamed Page"
            },
            {
                "dashboard_pageid": 2,
                "widgets": [
                    {
                        "type": "clock",
                        "x": 0,
                        "y": 0,
                        "width": 12,
                        "height": 3
                    }
                ]
            },
            {
                "display_period": 60
            }
        ]
    },
    "id": 1
}
```

Response:

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

[comment]: # ({/ed5d0499-b8348b8a})

[comment]: # ({6990c258-e4a57dd3})
#### Изменение владельца панели мониторинга

Доступно только администраторам и супер-администраторам.

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

```json
{
    "jsonrpc": "2.0",
    "method": "dashboard.update",
    "params": {
        "dashboardid": "2",
        "userid": "1"
    },
    "id": 1
}
```

Ответ:

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

[comment]: # ({/6990c258-e4a57dd3})

[comment]: # ({9c4ba6ce-299ae089})
### См. также

-   [Страница панели](object#dashboard-page)
-   [Виджет панели](object#dashboard-widget)
-   [Поле виджета панели](object#dashboard-widget-field)
-   [Пользователь панели](object#dashboard-user)
-   [Группа пользователей панели](object#dashboard-user-group)

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

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

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

[comment]: # ({/456ac32b-456ac32b})