mediatype.get

Описание

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

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

Параметры

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

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

Параметр	Тип	Описание
mediatypeids	строка/массив	Возврат способов оповещения только с заданными ID.
mediaids	строка/массив	Возврат только тех способов оповещения, которые используются заданными оповещениями пользователей.
userids	строка/массив	Возврат только тех способов оповещения, которые используются заданными пользователями.
selectUsers	запрос	Возврат пользователей, которые используют способ оповещения, в свойстве `users`.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `mediatypeid`.
countOutput	логический	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	логический
filter	объект
limit	целое число
output	запрос
preservekeys	логический
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	логический

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

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

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

Примеры

Получение способов оповещения

Получение всех добавленных способов оповещения.

Запрос:

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

Ответ:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "mediatypeid": "1",
                   "type": "0",
                   "description": "Email",
                   "smtp_server": "mail.company.com",
                   "smtp_helo": "company.com",
                   "smtp_email": "[email protected]",
                   "exec_path": "",
                   "gsm_modem": "",
                   "username": "",
                   "passwd": "",
                   "status": "0",
                   "maxsessions": "1",
                   "maxattempts": "7",
                   "attempt_interval": "10s"
               },
               {
                   "mediatypeid": "2",
                   "type": "3",
                   "description": "Jabber",
                   "smtp_server": "",
                   "smtp_helo": "",
                   "smtp_email": "",
                   "exec_path": "",
                   "gsm_modem": "",
                   "username": "[email protected]",
                   "passwd": "zabbix",
                   "status": "0",
                   "maxsessions": "1",
                   "maxattempts": "7",
                   "attempt_interval": "10s"
               },
               {
                   "mediatypeid": "3",
                   "type": "2",
                   "description": "SMS",
                   "smtp_server": "",
                   "smtp_helo": "",
                   "smtp_email": "",
                   "exec_path": "",
                   "gsm_modem": "/dev/ttyS0",
                   "username": "",
                   "passwd": "",
                   "status": "0",
                   "maxsessions": "1",
                   "maxattempts": "7",
                   "attempt_interval": "10s"
               }
           ],
           "id": 1
       }

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

Пользователь

Исходный код

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

Documentation