Documentation
Table of Contents
templatescreen.get
Description
целое число/массив templatescreen.get(объект параметры)
Этот метод позволяет получать комплексные экраны шаблонов в соответствии с заданными параметрами.
Параметры
(объект) Параметры задают желаемый вывод.
Этот метод поддерживает следующие параметры.
| Параметр | Тип | Описание |
|---|---|---|
| hostids | строка/массив | Возврат только тех комплексных экранов шаблонов, которые принадлежат заданным узлам сети. |
| screenids | строка/массив | Возврат комплексных экранов шаблонов только с заданными ID. |
| screenitemids | строка/массив | Возврат только тех комплексных экранов шаблонов, которые содержат заданные элементы комплексного экрана. |
| templateids | строка/массив | Возврат только тех комплексных экранов шаблонов, которые принадлежат заданным шаблонам. |
| noInheritance | флаг | Не возвращать унаследованные комплексные экраны шаблонов. |
| selectScreenItems | запрос | Возврат элементов комплексного экрана, которые используются в комплексном экране шаблона, в свойстве screenitems. |
| sortfield | строка/массив | Сортировка результата в соответствии с заданными свойствами. Возможные значения: screenid и name. |
| countOutput | логический | Эти параметры являются общими для всех методов get и они описаны в справочных комментариях. |
| editable | логический | |
| excludeSearch | логический | |
| filter | объект | |
| limit | целое число | |
| output | запрос | |
| preservekeys | логический | |
| search | объект | |
| searchByAny | логический | |
| searchWildcardsEnabled | логический | |
| sortorder | строка/массив | |
| startSearch | логический |
Возвращаемые значения
(целое число/массив) Возвращает либо:
- массив объектов;
- количество найденных объектов, если используется параметр
countOutput.
Примеры
Получение комплексных экранов с шаблона
Получение всех комплексных экранов с шаблона "10001" и всех его элементов комплексного экрана.
Запрос:
{ "jsonrpc": "2.0", "method": "templatescreen.get", "params": { "output": "extend", "selectScreenItems": "extend", "templateids": "10001" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }Ответ:
{ "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 }Смотрите также
Исходный код
CTemplateScreen::get() в frontends/php/include/classes/api/services/CTemplateScreen.php.