object templatedashboard.update(object/array templateDashboards)
此方法允许更新现有的模板仪表板。
此方法仅适用于管理员和超级管理员用户类型。调用该方法的权限可以在用户角色设置中撤销。更多信息请参阅User roles。
(object/array)
待更新的模板仪表板属性
每个仪表板必须指定dashboardid
属性,其他属性均为可选。仅指定的属性会被更新。
除模板仪表盘外,该方法还接受以下参数。
参数 | 数据类型 | 描述 |
---|---|---|
pages | array | 用于替换现有仪表板页面的模板仪表板模板仪表盘页面 仪表板页面通过 dashboard_pageid 属性更新。对于未指定dashboard_pageid 属性的objects将创建新仪表板页面,未重用的现有仪表板页面将被删除。仪表板页面将按指定顺序排序。仅更新仪表板页面的指定属性。pages 属性要求至少包含一个仪表板页面object |
(object)
返回一个包含更新后模板仪表板ID的object,存储在dashboardids
属性下。
将模板仪表板重命名为"性能图表"。
请求:
{
"jsonrpc": "2.0",
"method": "templatedashboard.update",
"params": {
"dashboardid": "23",
"name": "Performance graphs"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"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
}
响应:
CTemplateDashboard::update() 方法位于 ui/include/classes/api/services/CTemplateDashboard.php 文件中。