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定义所需输出的参数.

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.
countOutput flagThese parameters being common for all get methods are described in detail in the reference commentary. 在reference commentary中详细描述了所有get方法的这些参数。
editable boolean
excludeSearch flag
filter object
limit integer
output query
preservekeys flag
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch flag

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请求:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "method": "templatescreen.get",
  4.     "params":  {
  5.         "output": "extend",
  6.         "selectScreenItems": "extend",
  7.         "templateids": "10001"
  8.     },
  9.     "auth": "038e1d7b1735c6a5436ee9eae095879e",
  10.     "id": 1
  11. }

Response响应:

  1. {
  2.     "jsonrpc": "2.0",
  3.     "result": [
  4.         {
  5.             "screenid": "3",
  6.             "name": "System performance",
  7.             "hsize": "2",
  8.             "vsize": "2",
  9.             "templateid": "10001",
  10.             "screenitems": [
  11.                 {
  12.                     "screenitemid": "20",
  13.                     "screenid": "3",
  14.                     "resourcetype": "0",
  15.                     "resourceid": "433",
  16.                     "width": "500",
  17.                     "height": "120",
  18.                     "x": "0",
  19.                     "y": "0",
  20.                     "colspan": "1",
  21.                     "rowspan": "1",
  22.                     "elements": "0",
  23.                     "valign": "1",
  24.                     "halign": "0",
  25.                     "style": "0",
  26.                     "url": ""
  27.                 },
  28.                 {
  29.                     "screenitemid": "21",
  30.                     "screenid": "3",
  31.                     "resourcetype": "0",
  32.                     "resourceid": "387",
  33.                     "width": "500",
  34.                     "height": "100",
  35.                     "x": "0",
  36.                     "y": "1",
  37.                     "colspan": "1",
  38.                     "rowspan": "1",
  39.                     "elements": "0",
  40.                     "valign": "1",
  41.                     "halign": "0",
  42.                     "style": "0",
  43.                     "url": ""
  44.                 },
  45.                 {
  46.                     "screenitemid": "22",
  47.                     "screenid": "3",
  48.                     "resourcetype": "1",
  49.                     "resourceid": "10013",
  50.                     "width": "500",
  51.                     "height": "148",
  52.                     "x": "1",
  53.                     "y": "0",
  54.                     "colspan": "1",
  55.                     "rowspan": "1",
  56.                     "elements": "0",
  57.                     "valign": "1",
  58.                     "halign": "0",
  59.                     "style": "0",
  60.                     "url": ""
  61.                 },
  62.                 {
  63.                     "screenitemid": "23",
  64.                     "screenid": "3",
  65.                     "resourcetype": "1",
  66.                     "resourceid": "22181",
  67.                     "width": "500",
  68.                     "height": "184",
  69.                     "x": "1",
  70.                     "y": "1",
  71.                     "colspan": "1",
  72.                     "rowspan": "1",
  73.                     "elements": "0",
  74.                     "valign": "1",
  75.                     "halign": "0",
  76.                     "style": "0",
  77.                     "url": ""
  78.                 }
  79.             ]
  80.         }
  81.     ],
  82.     "id": 1
  83. }

See also参考

Source来源

CTemplateScreen::get() in frontends/php/include/classes/api/services/CTemplateScreen.php.