Zabbix Documentation 4.4

2.23.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.43.23.4

User Tools

Site Tools


Sidebar

ru:manual:api:reference:templatescreenitem:get

templatescreenitem.get

Описание

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

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

Параметры

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

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

Параметр Тип Описание
screenids строка/массив Возврат только тех элементов комплексного экрана шаблона, которые принадлежат заданным комплексным экранам шаблона.
screenitemids строка/массив Возврат элементов комплексного экрана шаблона только с заданными ID.
hostids строка/массив Возврат дополнительного свойства real_resourceid по каждому элементу комплексного экрана шаблона, которые принадлежат комплексному экрану с заданных узлов сети или шаблонов. Свойство real_resourceid содержит ID отображаемого объекта на комплексном экране.
sortfield строка/массив Сортировка результата в соответствии с заданными свойствами.

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

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

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

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

Примеры

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

Получение элементов комплексного экрана шаблона с комплексного экрана шаблона “15”.

Запрос:

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

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "screenitemid": "42",
            "screenid": "15",
            "resourcetype": "0",
            "resourceid": "454",
            "width": "500",
            "height": "200",
            "x": "0",
            "y": "0",
            "colspan": "1",
            "rowspan": "1",
            "elements": "0",
            "valign": "1",
            "halign": "0",
            "style": "0",
            "url": "",
            "max_columns": "3"
        },
        {
            "screenitemid": "43",
            "screenid": "15",
            "resourcetype": "0",
            "resourceid": "455",
            "width": "500",
            "height": "270",
            "x": "1",
            "y": "0",
            "colspan": "1",
            "rowspan": "1",
            "elements": "0",
            "valign": "1",
            "halign": "0",
            "style": "0",
            "url": "",
            "max_columns": "3"
        }
    ],
    "id": 1
}

Исходный код

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