dashboard.update

描述

object dashboard.update(object/array dashboards)

该方法允许更新现有的仪表板。

此方法可供任何类型的用户使用。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅User roles

参数

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

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

仪表盘外,该方法还接受以下参数。

参数 数据类型 描述
pages array 用于替换现有仪表板页面的仪表板页面

仪表板页面通过dashboard_pageid属性更新。对于没有dashboard_pageid属性的objects将创建新页面,未重用的现有页面将被删除。页面将按指定顺序排序。仅更新仪表板页面的指定属性。pages属性要求至少包含一个仪表板页面object。
users array 用于替换现有元素的仪表盘用户共享配置。
userGroups array 用于替换现有元素的dashboard-用户组共享配置。

返回值

(object) 返回一个包含更新后仪表板ID的object,存储于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 文件中。