Sidebar

zh:manual:api:reference:templatescreen:get

获取

Description 说明

integer/array templatescreen.get(object parameters)

The method allows to retrieve template screens according to the given parameters. 此方法允许根据指定的参数来检索聚合图形模板。

Parameters 参数

(object) Parameters defining the desired output. (object)定义所需输出的参数。 The method supports the following parameters. 该方法支持以下参数。

Parameter 参数 Type 类型 Description 说明
hostids string/array 字符串/数组 Return only template screens that belong to the given hosts. 仅返回指定主机所属的聚合图形模板。
screenids string/array 字符串/数组 Return only template screens with the given IDs. 仅返回指定ID的聚合图形模板。
screenitemids string/array 字符串/数组 Return only template screens that contain the given screen items. 仅返回包含指定聚合图形项的聚合图形模板。
templateids string/arary 字符串/数组 Return only template screens that belong to the given templates. 仅返回指定模板所属的聚合图形模板。
noInheritance flag 标记 Do not return inherited template screens. 不返回继承的聚合图形模板。
selectScreenItems query 查询 Return the screen items that are used in the template screen in the screenitems property. 返回screenitems属性中聚合图形模板使用的聚合图形项。
sortfield string/array 字符串/数组 Sort the result by the given properties. 按指定的属性对结果分类。

Possible values are: screenid and name. 许可值为:screenidname
countOutput boolean 布尔值 These parameters being common for all get methods are described in detail in the reference commentary. 这些参数非常普遍,适用于所有的get方法,详情可在reference commentary中参考。
editable boolean 布尔值
excludeSearch boolean 布尔值
filter object 对象
limit integer 整数型
output query 查询
preservekeys boolean 布尔值
search object 对象
searchByAny boolean 布尔值
searchWildcardsEnabled boolean 布尔值
sortorder string/array 字符串/数组
startSearch boolean 布尔值

Return values 返回值

(integer/array) Returns either: 返回两者其中任一:

  • an array of objects; 一组对象;
  • the count of retrieved objects, if the countOutput parameter has been used. 如果已经使用了countOutput参数,则检索对象的计数。

Examples 范例

Retrieve screens from template 从模板中检索聚合图形

Retrieve all screens from template “10001” and all of the screen items. 从模板“10001”中检索所有聚合图形以及检索所有聚合图形项。

Request 请求:

{
    "jsonrpc": "2.0",
    "method": "templatescreen.get",
    "params":  {
        "output": "extend",
        "selectScreenItems": "extend",
        "templateids": "10001"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Response 响应:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "screenid": "3",
            "name": "System performance",
            "hsize": "2",
            "vsize": "2",
            "templateid": "10001",
            "screenitems": [
                {
                    "screenitemid": "20",
                    "screenid": "3",
                    "resourcetype": "0",
                    "resourceid": "433",
                    "width": "500",
                    "height": "120",
                    "x": "0",
                    "y": "0",
                    "colspan": "1",
                    "rowspan": "1",
                    "elements": "0",
                    "valign": "1",
                    "halign": "0",
                    "style": "0",
                    "url": ""
                },
                {
                    "screenitemid": "21",
                    "screenid": "3",
                    "resourcetype": "0",
                    "resourceid": "387",
                    "width": "500",
                    "height": "100",
                    "x": "0",
                    "y": "1",
                    "colspan": "1",
                    "rowspan": "1",
                    "elements": "0",
                    "valign": "1",
                    "halign": "0",
                    "style": "0",
                    "url": ""
                },
                {
                    "screenitemid": "22",
                    "screenid": "3",
                    "resourcetype": "1",
                    "resourceid": "10013",
                    "width": "500",
                    "height": "148",
                    "x": "1",
                    "y": "0",
                    "colspan": "1",
                    "rowspan": "1",
                    "elements": "0",
                    "valign": "1",
                    "halign": "0",
                    "style": "0",
                    "url": ""
                },
                {
                    "screenitemid": "23",
                    "screenid": "3",
                    "resourcetype": "1",
                    "resourceid": "22181",
                    "width": "500",
                    "height": "184",
                    "x": "1",
                    "y": "1",
                    "colspan": "1",
                    "rowspan": "1",
                    "elements": "0",
                    "valign": "1",
                    "halign": "0",
                    "style": "0",
                    "url": ""
                }
            ]
        }
    ],
    "id": 1
}

See also 参考

Source 源码

CTemplateScreen::get() in frontends/php/include/classes/api/services/CTemplateScreen.php. CTemplateScreen::get()方法可在frontends/php/include/classes/api/services/CTemplateScreen.php中参考。