screen.get

Описание

целое число/массив screen.get(объект параметры)

Этот метод позволяет получать комплексные экраны в соответствии с заданными параметрами.

Параметры

(объект) Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

Параметр	Тип	Описание
screenids	строка/массив	Возврат комплексных экранов только с заданными ID.
screenitemids	строка/массив	Возврат только тех комплексных экранов, которые содержат заданные элементы комплексного экрана.
selectScreenItems	запрос	Возврат элементов комплексного экрана, которые используются в комплексном экране.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `screenid` и `name`.
countOutput	флаг	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	флаг
filter	объект
limit	целое число
nodeids	строка/массив
output	запрос
preservekeys	флаг
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	флаг

Возвращаемые значения

(целое число/массив) Возвращает либо:

массив объектов;
количество найденных объектов, если используется параметр countOutput.

Примеры

Получение комплексного экрана по ID

Получение всех данных о комплексном экране "26" и его элементов комплексного экрана.

Запрос:

{
           "jsonrpc": "2.0",
           "method": "screen.get",
           "params": {
               "output": "extend",
               "selectScreenItems": "extend",
               "screenids": "26"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": [    
               {
                   "screenitems": [
                       {
                           "screenitemid": "67",
                           "screenid": "26",
                           "resourcetype": "0",
                           "resourceid": "612",
                           "width": "320",
                           "height": "200",
                           "x": "0",
                           "y": "0",
                           "colspan": "0",
                           "rowspan": "0",
                           "elements": "25",
                           "valign": "0",
                           "halign": "0",
                           "style": "0",
                           "url": "",
                           "dynamic": "0",
                           "sort_triggers": "0"
                       }
                   ],
                   "screenid": "26",
                   "name": "CPU Graphs",
                   "hsize": "3",
                   "vsize": "2",
                   "templateid": "0"
               }
           ],
           "id": 1
       }

Смотрите также

Элемент комплексного экрана

Исходный код

CScreen::get() в frontends/php/api/classes/CScreen.php.

Documentation