Приложение 1. Справочные комментарии

Обозначение

Типы данных

Zabbix API поддерживает следующие типы данных:

Тип	Описание
логический	Логическое значение, принимает либо `true`, либо `false`.
флаг	Значение считается `true`, если оно указано и не равно `null` и `false`, в противном случае.
целое число	Целое число.
дробное число	Число с плавающей точкой.
строка	Текстовая строка.
текст	Более длинная строка текста.
штамп времени	Штамп времени в формате Unix.
массив	Упорядоченная последовательность значения, то есть, простой массив.
объект	Ассоциативный массив.
запрос	Значение, которое определяет какие данные необходимо вернуть. Может быть задано массивом имен свойств, чтобы возвращались только указанные свойства или, в том числе, одно из предопределенных значений: `extend` - возвращает все свойства объекта; `count` - возвращает количество полученных записей, поддерживается только некоторыми подзапросами.

Подписи к свойствам

Некоторые из свойств объектов маркируются короткими подписями, чтобы описать их поведение. Используются следующие подписи:

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

Удаление ссылки на объект через API

Зарезервированное значение ID "0" можно использовать для удаления ссылок на объекты. Например, для удаления ссылки на прокси с узла сети, proxy_hostid необходимо задать значением 0 ("proxy_hostid": "0").

Общие параметры "get" метода

Следующие параметры поддерживаются всеми get методами:

Параметр	Тип	Описание
countOutput	флаг	Возвращает в результате количество записей вместо актуальных данных.
editable	логический	Если задано равным `true`, возвращает только те объекты на которые у пользователя есть права на запись. По умолчанию: `false`.
excludeSearch	флаг	Возвращает результаты, которые не совпадают с заданным критерием `search` параметре.
filter	объект	Возвращать только те результаты, которые в точности совпадают с заданным фильтром. Принимает массив, где ключи являются именами свойств и значения, либо одно значение, либо массив значений соответствий. Не работает с `text` полями.
limit	целое число	Ограничение количества возвращаемых записей.
nodeids	строка/массив	Возвращает объекты, которые принадлежат заданным нодам.
output	запрос	Свойства возвращаемых объектов. По умолчанию: `extend`.
preservekeys	флаг	Использование ID как ключей в результирующем массиве.
search	объект	Возвращаемые результаты, которые соответствуют заданному шаблону поиска. Принимает массив, где ключами являются имена свойств и строковые значения для поиска. Если не заданы дополнительные опции, эта опция выполнит `LIKE "%…%"` поиск. Работает только с `string` и `text` полями.
searchByAny	логический	Если задано равным `true`, возвращает результаты которые совпадают с любым из заданных критериев в `filter` или `search` параметрах вместо соответствия по всем. По умолчанию: `false`.
searchWildcardsEnabled	логический	Если задано равным `true`, включает использование "*" символом шаблона в `search` параметре. По умолчанию: `false`.
sortfield	строка/массив	Сортировка результата по заданным свойствам. Обратитесь к отдельным описаниям get методов API для получения списка свойств, которые можно использовать при сортировке. Макросы не раскрываются до сортировки.
sortorder	строка/массив	Порядок сортировки. Если передан массив, каждое значение будет сопоставляться соответствующему свойству из `sortfield` параметра. Возможные значения: `ASC` - по возрастанию; `DESC` - по убыванию.
startSearch	флаг	`search` параметр будет сравнивать начало полей, то есть, выполнять `LIKE "…%"` поиск.

Documentation