Sidebar

zh:manual:api:reference:templatescreen:update

更新

说明

object templatescreen.update(object/array templateScreens)

此方法允许更新现有的聚合图形模板。

参数

(object/array)需要更新的聚合图形模板属性。

必须为每个聚合图形模板定义screenid属性,所有其他属性为可选项。只有通过的属性会被更新,所有其他属性将保持不变。

standard template screen properties之外,该方法接受以下参数。

参数 类型 说明
screenitems array 用来替换现有内容的聚合图形项
聚合图形项通过坐标轴更新,因此每个聚合图形项必须定义xy属性。

返回值

(object)返回一个对象,该对象包含在screenids属性中已更新聚合图形模板的ID。

范例

重命名聚合图形模板

将聚合图形模板重命名为“Performance graphs”。

Request 请求:

{
    "jsonrpc": "2.0",
    "method": "templatescreen.update",
    "params": {
        "screenid": "3",
        "name": "Performance graphs"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response 响应:

{
    "jsonrpc": "2.0",
    "result": {
        "screenids": [
            "3"
        ]
    },
    "id": 1
}

源码

CTemplateScreen::update()方法可在ui/include/classes/api/services/CTemplateScreen.php中参考。