获取

描述

integer/array templatescreenitem.get(object **parameters**)

此方法允许根据指定的参数检索聚合图形项模板。

参数

(object)定义所需输出的参数。 该方法提供以下参数。

参数类型描述
screenidsstring/array仅返回指定所属聚合图形模板的聚合图形项模板ID。
screenitemidsstring/array仅返回指定ID的聚合图形项模板。
hostidsstring/array为每个聚合图形项模板返回一个额外的“real_resourceid”属性，该属性属于指定主机或模板的聚合图形。real_resourceid属性包含显示在聚合图形中的对象ID。
sortfieldstring/array按给定属性对结果排序。

可能值：screenitemid和screenid。
countOutputboolean这些参数很常用，适用于所有get方法，详情可参考reference commentary。
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

返回值

(integer/array) 返回两者其中任一：

  • 一组对象；

  • 若已使用了countOutput参数，则检索对象的计数。

示例

为聚合图形检索聚合图形项模板

从聚合图形模板“15”中返回所有聚合图形项模板。

请求:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "templatescreenitem.get",
  4.     "params": {
  5.         "output": "extend",
  6.         "screenids": "15"
  7.     },
  8.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  9.     "id": 1
  10. }

响应:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "screenitemid": "42",
  6.             "screenid": "15",
  7.             "resourcetype": "0",
  8.             "resourceid": "454",
  9.             "width": "500",
  10.             "height": "200",
  11.             "x": "0",
  12.             "y": "0",
  13.             "colspan": "1",
  14.             "rowspan": "1",
  15.             "elements": "0",
  16.             "valign": "1",
  17.             "halign": "0",
  18.             "style": "0",
  19.             "url": "",
  20.             "max_columns": "3"
  21.         },
  22.         {
  23.             "screenitemid": "43",
  24.             "screenid": "15",
  25.             "resourcetype": "0",
  26.             "resourceid": "455",
  27.             "width": "500",
  28.             "height": "270",
  29.             "x": "1",
  30.             "y": "0",
  31.             "colspan": "1",
  32.             "rowspan": "1",
  33.             "elements": "0",
  34.             "valign": "1",
  35.             "halign": "0",
  36.             "style": "0",
  37.             "url": "",
  38.             "max_columns": "3"
  39.         }
  40.     ],
  41.     "id": 1
  42. }

来源

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