dashboard.update

描述

object dashboard.update(object/array dashboards)

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

该方法适用于所有类型的用户. 调用该方法的权限可以在用户角色设置中撤销. 更多信息请参阅User roles.

参数

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

每个仪表板必须指定 dashboardid 属性，其他所有属性均为可选。仅指定的属性会被更新。

除了仪表盘之外，该方法还接受以下参数。

参数	数据类型	描述
pages	array	用于替换现有仪表板页面的仪表板仪表板页面。仪表板页面通过 `dashboard_pageid` 属性更新。对于没有 `dashboard_pageid` 属性的 objects 将创建新的仪表板页面，未重用的现有仪表板页面将被删除。仪表板页面将按照指定的顺序排序。仅仪表板页面的指定属性会被更新。`pages` 属性至少需要一个仪表板页面 object。
users	array	用于替换现有元素的仪表板仪表盘用户共享。
userGroups	array	用于替换现有元素的仪表板 dashboard-用户组共享。

返回值

(object) 返回一个包含更新仪表板ID的object，这些ID位于dashboardids属性下。

示例

重命名仪表板

将仪表板重命名为"SQL服务器状态".

请求:

{
           "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",
               "pages": [
                   {
                       "dashboard_pageid": 1,
                       "name": 'Renamed Page'
                   },
                   {
                       "dashboard_pageid": 2,
                       "widgets": [
                           {
                               "type": "clock",
                               "x": 0,
                               "y": 0,
                               "width": 4,
                               "height": 3
                           }
                       ]
                   },
                   {
                       "display_period": 60
                   }
               ]
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应:

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

更改仪表盘所有者

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

请求:

{
           "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() 位于 ui/include/classes/api/services/CDashboard.php。

Documentation

dashboard.update

描述

参数

返回值

示例

重命名仪表板

更新仪表板页面

更改仪表盘所有者

另请参阅

来源