更新模板仪表盘

更新模板仪表盘

描述

object templatedashboard.update(object/array templateDashboards)

此方法允许更新现有模板仪表盘。

此方法仅适用于管理员和超级管理员用户类型。可以在用户角色设置中撤销调用该方法的权限。详情查阅 User roles。

参数

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

必须为每个仪表盘指定dashboardid属性，其他所有属性都是可选的。只会更新指定的属性。

除了标准模版仪表盘属性外，该方法还接受以下参数。

参数	类型	描述
pages	array	模板仪表盘页面以替换现有仪表盘页面。仪表盘页面按`dashboard_pageid`属性更新。将为没有`dashboard_pageid`属性的对象创建新的仪表盘页面，如果不重用，现有的仪表盘页面将被删除。仪表盘页面将按指定的顺序排序。只会更新仪表盘页面的指定属性。`pages`属性至少需要一个仪表盘页面对象。

返回值

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

示例

重命名一个模板仪表盘

将一个模板仪表盘重命名为”Performance graphs”。

请求：

{
           "jsonrpc": "2.0",
           "method": "templatedashboard.update",
           "params": {
               "dashboardid": "23",
               "name": "Performance graphs"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

响应：

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

更新模板仪表盘页面

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

请求：

{
           "jsonrpc": "2.0",
           "method": "templatedashboard.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
       }

参阅

源码

CTemplateDashboard::update() in ui/include/classes/api/services/CTemplateDashboard.php.