更新

描述

object dashboard.update(object/array dashboards)

这个方法允许更新已存在的仪表板。

参数

(object/array) 要更新的仪表板的属性。

必须为每个仪表板定义 dashboardid 属性，其它的属性都是可选的。只有传递的属性会被更新，其它属性都将保持不变。

另外，对于标准仪表板属性，该方法接受以下参数。

参数类	描述
widgets	数组替	已存在的仪表板小部件的仪表板小组件。表板小部件由`widgetid`属性更新。将创建没有 `widgetid` 属性的小部件。
users	数组替	已存在的部件的仪表板用户共享。
userGroups	数组替	已存在的部件的仪表板用户组共享。

返回值

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

示例

重命名一个仪表板

将一个仪表板重命名为“SQL server 状态”。

请求：

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

响应：

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

改变仪表板的属主

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

请求：

{
           "jsonrpc": "2.0",
           "method": "dashboard.update",
           "params": {
               "dashboardid": "2",
               "userid": "1"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 2
       }

响应：

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

参见

来源

CDashboard::update() in frontends/php/include/classes/api/services/CDashboard.php.

Documentation

更新

描述

参数

返回值

示例

重命名一个仪表板

改变仪表板的属主

参见

来源