更新

描述

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

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

参数

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

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

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

参数类型描述
widgets数组替代已存在的仪表板小部件的仪表板小组件。

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

返回值

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

示例

重命名一个仪表板

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

请求：

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "dashboard.update",
  4.     "params": {
  5.         "dashboardid": "2",
  6.         "name": "SQL server status"
  7.     },
  8.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9.     "id": 1
  10. }

响应：

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": {
  4.         "dashboardids": [
  5.             "2"
  6.         ]
  7.     },
  8.     "id": 1
  9. }

改变仪表板的属主

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

请求：

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "dashboard.update",
  4.     "params": {
  5.         "dashboardid": "2",
  6.         "userid": "1"
  7.     },
  8.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9.     "id": 2
  10. }

响应：

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": {
  4.         "dashboardids": [
  5.             "2"
  6.         ]
  7.     },
  8.     "id": 2
  9. }

参见

来源

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