[comment]: # translation:outdated

[comment]: # aside: 5

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

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

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

`object dashboard.update(object/array dashboards)`

此方法允许update现有仪表板.

::: noteclassic
该方法适用于所有类型的用户. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅[User
roles](/manual/web_interface/frontend_sections/users/user_roles).

:::

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

[comment]: # ({eccee0d8-62947aa0})
### 参数

`(object/array)` 需要更新的仪表板属性.

每个仪表板必须定义 `dashboardid` 属性，其他所有属性均为可选。仅传递的属性会被更新，其余属性将保持不变。

除了 [仪表盘](object#仪表盘) 外，
该方法还接受以下参数。

| 参数 | [数据类型](/manual/api/reference_commentary#数据类型) | 描述 |
|--|--|------|
| pages | array | 用于替换现有仪表板页面的 [仪表板页面](object#仪表板页面)。<br><br>仪表板页面通过 `dashboard_pageid` 属性进行更新。对于没有 `dashboard_pageid` 属性的 objects 将创建新的仪表板页面，未重用的现有仪表板页面将被删除。仪表板页面将按照指定的顺序排序。仅更新仪表板页面的指定属性。 |
| users | array | 用于替换现有元素的 [仪表盘用户](object#仪表盘用户) 共享。 |
| userGroups | array | 用于替换现有元素的 [dashboard-用户组](object#dashboard-用户组) 共享。 |

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

[comment]: # ({28e89b38-28e89b38})
### 返回值

`(object)` 返回一个包含更新后仪表板ID的object对象，该对象位于`dashboardids`属性下。

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

[comment]: # ({b41637d2-b41637d2})
### 示例

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

[comment]: # ({d0eb0276-7fcf7de4})
#### 重命名仪表板

将仪表板重命名为"SQL server状态".

[执行请求](/manual/api#执行请求):

```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})
#### 更新仪表板页面

重命名第一个仪表板页面，替换第二个仪表板页面上的部件，
并添加一个新页面作为第三个页面。删除所有其他仪表板页面。

[执行请求](/manual/api#执行请求):

```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
}
```
响应:

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

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

[comment]: # ({6990c258-e4a57dd3})
#### 更改仪表盘所有者

仅限管理员和超级管理员使用。

[执行请求](/manual/api#执行请求):

```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]: # ({299ae089-299ae089})
### 另请参阅

-   [仪表板页面](object#仪表板页面)
-   [仪表板小部件](object#仪表板小部件)
-   [仪表板小部件字段](object#仪表板小部件字段)
-   [仪表盘用户](object#仪表盘用户)
-   [dashboard-用户组](object#dashboard-用户组)

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

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

CDashboard::update() 位于
*ui/include/classes/api/services/CDashboard.php* 文件中.

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