[comment]: # translation:outdated

[comment]: # ({new-2a69f566})
# screen.get

[comment]: # ({/new-2a69f566})

[comment]: # ({new-015f28d0})
### Описание

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

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

[comment]: # ({/new-015f28d0})

[comment]: # ({new-e16852c6})
### Параметры

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

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

|Параметр|Тип|Описание|
|----------------|------|----------------|
|screenids|строка/массив|Возврат комплексных экранов только с заданными ID.|
|userids|строка/массив|Возврат только тех комплексных экранов, которые принадлежат заданным ID пользователей.|
|screenitemids|строка/массив|Возврат только тех комплексных экранов, которые содержат заданные элементы комплексного экрана.|
|selectScreenItems|запрос|Возврат элементов комплексного экрана, которые используются в комплексном экране.|
|selectUsers|запрос|Возврат пользователей, которым предоставлен общий доступ к комплексному экрану, в свойстве `users`.|
|selectUserGroups|запрос|Возврат групп пользователей, которым предоставлен общий доступ к комплексному экрану, в свойстве `userGroups`.|
|sortfield|строка/массив|Сортировка результата в соответствии с заданными свойствами.<br><br>Возможные значения: `screenid` и `name`.|
|countOutput|логический|Эти параметры являются общими для всех методов `get` и они описаны в [справочных комментариях](/ru/manual/api/reference_commentary#общие_параметры_get_метода).|
|editable|логический|^|
|excludeSearch|логический|^|
|filter|объект|^|
|limit|целое число|^|
|output|запрос|^|
|preservekeys|логический|^|
|search|объект|^|
|searchByAny|логический|^|
|searchWildcardsEnabled|логический|^|
|sortorder|строка/массив|^|
|startSearch|логический|^|

[comment]: # ({/new-e16852c6})

[comment]: # ({new-7223bab1})
### Возвращаемые значения

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

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

[comment]: # ({/new-7223bab1})

[comment]: # ({new-b41637d2})
### Примеры

[comment]: # ({/new-b41637d2})

[comment]: # ({new-e68a8713})
#### Получение комплексного экрана по ID

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

Запрос:

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

Ответ:

``` {.java}
{
    "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"
                }
            ],
            "users": [
                {
                    "sysmapuserid": "1",
                    "userid": "2",
                    "permission": "2"
                }
            ],
            "userGroups": [
                {
                    "screenusrgrpid": "1",
                    "usrgrpid": "7",
                    "permission": "3"
                }
            ],
            "screenid": "26",
            "name": "CPU Graphs",
            "hsize": "3",
            "vsize": "2",
            "templateid": "0",
            "userid": "1",
            "private": "1"
        }
    ],
    "id": 1
}
```

[comment]: # ({/new-e68a8713})

[comment]: # ({new-796d9b7a})
### Смотрите также

-   [Элемент комплексного
    экрана](/ru/manual/api/reference/screenitem/object#элемент_комплексного_экрана)
-   [Пользователь комплексного
    экрана](object#пользователь_комплексного_экрана)
-   [Группа пользователей комплексного
    экрана](object#группа_пользователей_комплексного_экрана)

[comment]: # ({/new-796d9b7a})

[comment]: # ({new-46649b7f})
### Исходный код

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

[comment]: # ({/new-46649b7f})