screenitem.get

Описание

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

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

Параметры

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

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

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

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

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

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

Примеры

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

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

Запрос:

{
           "jsonrpc": "2.0",
           "method": "screenitem.get",
           "params": {
               "output": "extend",
               "screenids": "3"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Ответ:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "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": "",
                   "dynamic": "0",
                   "sort_triggers": "0"
               },
               {
                   "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": "",
                   "dynamic": "0",
                   "sort_triggers": "0"
               },
               {
                   "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": "",
                   "dynamic": "0",
                   "sort_triggers": "0"
               },
               {
                   "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": "",
                   "dynamic": "0",
                   "sort_triggers": "0"
               }
           ],
           "id": 1
       }

Исходный код

CScreenItem::get() в frontends/php/include/classes/api/services/CScreenItem.php.

Documentation