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.

ParameterTypeDescription
hostidsstring/arrayReturn only template screens that belong to the given hosts.
screenidsstring/arrayReturn only template screens with the given IDs.
screenitemidsstring/arrayReturn only template screens that contain the given screen items.
templateidsstring/araryReturn only template screens that belong to the given templates.
noInheritanceflagDo not return inherited template screens.
selectScreenItemsqueryReturn the screen items that are used in the template screen in the screenitems property.
sortfieldstring/arraySort the result by the given properties.

Possible values are: screenid and name.
countOutputbooleanThese parameters being common for all get methods are described in detail in the reference commentary.
editableboolean
excludeSearchboolean
filterobject
limitinteger
outputquery
preservekeysboolean
searchobject
searchByAnyboolean
searchWildcardsEnabledboolean
sortorderstring/array
startSearchboolean

Return values

(integer/array) Returns either:

  • an array of objects;

  • the count of retrieved objects, if the countOutput parameter has been used.

Examples

Retrieve screens from template

Retrieve all screens from template “10001” and all of the screen items.

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 ui/include/classes/api/services/CTemplateScreen.php.