templategroup.get

Описание

integer/array templategroup.get(параметры объекта)

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

Этот метод доступен пользователям любого типа. Разрешения на вызов метода можно отозвать в настройках ролей пользователя. Дополнительную информацию см. в разделе Роли пользователей.

Параметры

(object) Параметры, определяющие желаемый вывод.

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

Параметр Тип Описание
graphids ID/array Возвращать только группы шаблонов, содержащие шаблоны с указанными графиками.
groupids ID/array Возвращать только группы шаблонов с указанными ID групп шаблонов.
templateids ID/array Возвращать только группы шаблонов, содержащие указанные шаблоны.
triggerids ID/array Возвращать только группы шаблонов, содержащие шаблоны с указанными триггерами.
with_graphs boolean Возвращать только группы шаблонов, содержащие шаблоны с графиками.
with_graph_prototypes boolean Возвращать только группы шаблонов, содержащие шаблоны с прототипами графиков.
with_httptests boolean Возвращать только группы шаблонов, содержащие шаблоны с веб-проверками.
with_items boolean Возвращать только группы шаблонов, содержащие шаблоны с элементами данных.

Переопределяет параметры with_simple_graph_items.
with_item_prototypes boolean Возвращать только группы шаблонов, содержащие шаблоны с прототипами элементов данных.

Переопределяет параметр with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Возвращать только группы шаблонов, содержащие шаблоны с прототипами элементов данных, которые включены для создания и имеют числовой тип информации.
with_simple_graph_items boolean Возвращать только группы шаблонов, содержащие шаблоны с числовыми элементами данных.
with_templates boolean Возвращать только группы шаблонов, содержащие шаблоны.
with_triggers boolean Возвращать только группы шаблонов, содержащие шаблоны с триггерами.
selectTemplates query Возвращать свойство templates с шаблонами, принадлежащими группе шаблонов.

Поддерживает count.
limitSelects integer Ограничивает количество записей, возвращаемых подзапросами.

Применяется к следующим подзапросам:
selectTemplates — результаты будут отсортированы по template.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: groupid, name.
countOutput boolean Эти параметры описаны в справочном комментарии.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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

(integer/array) Возвращает одно из следующего:

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

Примеры

Получение данных по имени

Получите все данные о двух группах шаблонов с именами "Templates/Databases" и "Templates/Modules".

Запрос:

{
    "jsonrpc": "2.0",
    "method": "templategroup.get",
    "params": {
        "output": "extend",
        "filter": {
            "name": [
                "Templates/Databases",
                "Templates/Modules"
            ]
        }
    },
    "id": 1
}

Ответ:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "13",
            "name": "Templates/Databases",
            "uuid": "748ad4d098d447d492bb935c907f652f"
        },
        {
            "groupid": "8",
            "name": "Templates/Modules",
            "uuid": "57b7ae836ca64446ba2c296389c009b7"
        }
    ],
    "id": 1
}

См. также

Исходный код

CTemplateGroup::get() в ui/include/classes/api/services/CTemplateGroup.php.