Zabbix Documentation 3.4

3.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.22.43.23.4

User Tools

Site Tools

This translation is older than the original page and might be outdated. See what has changed.

Sidebar

ru:manual:api:reference:screen:get

screen.get

Описание

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

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

Параметры

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

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

Параметр Тип Описание
screenids строка/массив Возврат комплексных экранов только с заданными ID.
userids строка/массив Возврат только тех комплексных экранов, которые принадлежат заданным ID пользователей.
screenitemids строка/массив Возврат только тех комплексных экранов, которые содержат заданные элементы комплексного экрана.
selectScreenItems запрос Возврат элементов комплексного экрана, которые используются в комплексном экране.
selectUsers запрос Возврат пользователей, которым предоставлен общий доступ к комплексному экрану, в свойстве users.
selectUserGroups запрос Возврат групп пользователей, которым предоставлен общий доступ к комплексному экрану, в свойстве userGroups.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

Возможные значения: screenid и name.
countOutput логическийЭти параметры являются общими для всех методов get и они описаны в справочных комментариях.
editable логический
excludeSearch логический
filter объект
limit целое число
output запрос
preservekeys логический
search объект
searchByAny логический
searchWildcardsEnabled логический
sortorder строка/массив
startSearch логический

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

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

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

Примеры

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

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

Запрос:

{
    "jsonrpc": "2.0",
    "method": "screen.get",
    "params": {
        "output": "extend",
        "selectScreenItems": "extend",
        "selectUsers": "extend",
        "selectUserGroups": "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"
                }
            ],
            "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
}

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

Исходный код

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