templatedashboard.update
描述
object templatedashboard.update(object/array templateDashboards)
此方法允许update现有的模板仪表板。
此方法仅对管理员和超级管理员用户类型可用。可以在用户角色设置中撤销调用该方法的权限。更多信息请参见User roles。
参数
(object/array) 要更新的模板仪表板属性。
每个仪表板都必须指定 dashboardid 属性，其他所有属性均为可选。仅会更新指定的属性。
除了标准模板仪表板属性之外，该方法还接受以下参数。
| Parameter | Type | Description |
|---|---|---|
| pages | array | 用于替换现有仪表板页面的模板仪表板页面。 仪表板页面通过 dashboard_pageid 属性进行更新。对于未指定 dashboard_pageid 属性的对象，将创建新的仪表板页面；如果现有仪表板页面未被复用，则会被删除。仪表板页面将按照指定的顺序排列。仅会更新仪表板页面中指定的属性。pages 属性至少需要一个仪表板页面对象。 |
返回值
(object) 返回一个 object，其中包含在 dashboardids 属性下列出的已更新模板仪表板的 ID。
示例
重命名模板仪表盘
将模板仪表板重命名为“Performance graphs”。
执行请求:
{
"jsonrpc": "2.0",
"method": "templatedashboard.update",
"params": {
"dashboardid": "23",
"name": "Performance graphs"
},
"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": 12,
"height": 3
}
]
},
{
"display_period": 60
}
]
},
"id": 1
}响应：
{
"jsonrpc": "2.0",
"result": {
"dashboardids": [
"2"
]
},
"id": 1
}另请参见
来源
CTemplateDashboard::update() 位于 ui/include/classes/api/services/CTemplateDashboard.php 文件中。