Справочный центр Wialon

update_notification

Метод update_notification используется для создания, редактирования или удаления уведомлений.

Copied!
svc = "resource/update_notification"
params = {
  "itemId": <long>,
  "id": <long>,  // ID уведомления
  "callMode": "<text>",
  "e": <bool>,
  "n": "<text>",  // Имя
  "txt": "<text>",  // Текст уведомления
  "ta": <uint>,  // Время активации (формат Unix)
  "td": <uint>,  // Время деактивации (формат Unix)
  "ma": <uint>,  // Максимальное количество срабатываний (0 — не ограничено)
  "mmtd": <uint>,  // Максимальный временной интервал между сообщениями (сек.)
  "cdt": <uint>,  // Таймаут срабатывания (сек.)
  "mast": <uint>,  // Минимальная продолжительность тревожного состояния (сек.)
  "mpst": <uint>,  // Минимальная продолжительность предыдущего состояния (сек.)
  "cp": <uint>,  // Период контроля относительно текущего времени (сек.)
  "fl": <uint>,  // Флаги уведомления
  "tz": <int>,  // Часовой пояс
  "la": "<text>",  // Язык пользователя (двухбуквенный код)
  "un": [<long>],  // Массив ID объектов или групп объектов
  "d": "<text>",  // Описание уведомления
  "sch": {  // Расписание уведомления
    "f1": <uint>,  // Начало интервала 1 (минуты от полуночи)
    "f2": <uint>,  // Начало интервала 2 (минуты от полуночи)
    "t1": <uint>,  // Конец интервала 1 (минуты от полуночи)
    "t2": <uint>,  // Конец интервала 2 (минуты от полуночи)
    "m": <uint>,  // Маска дней месяца
    "y": <uint>,  // Маска месяцев
    "w": <uint>   // Маска дней недели
  },

  "ctrl_sch": {  // Расписание контроля максимального количества срабатываний
    "f1": <uint>,
    "f2": <uint>,
    "t1": <uint>,
    "t2": <uint>,
    "m": <uint>,
    "y": <uint>,
    "w": <uint>
  },

  "trg": {  // Контроль
    "t": "<text>",
    "p": {
      "<text>": "<text>",
      ...
    }
  },

  "act": [  // Действия
    {
      "t": "<text>",  // Тип действия
      "p": {
        "<text>": "<text>",  // Параметры
        ...
      }
    }
  ]
}

Описание флагов уведомлений и типов действий см. на странице get_notification_data.

Для уведомлений с типом контроля Простой значение параметра mast в секундах должно соответствовать значению параметра min_idle_time в минутах. Например, чтобы уведомление срабатывало после 10 минут простоя, укажите 10 в параметре min_idle_time и 600 в mast.

Параметры

Название Описание
itemId ID ресурса.
id ID уведомления (0 — создать).
callMode Действие: создание, редактирование, удаление, включение/отключение (create, update, delete, enable).
e Используется только для действия включения/отключения (enable):

  • false или 0 — отключить;
  • true или 1 — включить.
d Описание уведомления. Необязательный параметр. Если не указать его при редактировании уведомления, описание удаляется. Чтобы сохранить описание, передайте его текущее значение.

Другие параметры необходимы только для создания и редактирования. См. страницу get_notification_data.

Объекты и группы объектов, указанные в параметре un, добавляются в уведомление, только если у создателя ресурса есть право доступа Использование объекта в уведомлениях, заданиях, маршрутах, ретрансляторах к ним. Остальные объекты пропускаются без ошибки.

Ответ

Для запросов, связанных с созданием и редактированием:

Copied!
[
	<long>,				/* ID уведомления */
	{
		"id":<long>,	/* ID уведомления */
		"n":"<text>",		/* имя */
		"txt":"<text>",	/* текст уведомления */
		"ta":<uint>,	/* время активации (формат Unix) */
		"td":<uint>,	/* время деактивации (формат Unix) */
		"ma":<uint>,	/* максимальное количество срабатываний (0 — не ограничено) */
		"fl":<uint>,	/* флаги уведомлений */
		"ac":<uint>,	/* количество срабатываний */
		"un":[<long>],	/* массив ID объектов/групп объектов */
		"act":["<text>"],	/* действия */
		"trg":"<text>",	/* тип контроля */
		"trg_p":{},		/* настройки контроля */
		"crc":<long>,	/* контрольная сумма бинарного представления уведомления */ 
		"ct":<uint>,    /* время создания */  
		"mt":<uint>     /* время последнего изменения */
	}
]

Флаги уведомлений, типы действий и контроля описаны здесь.

Для запросов, связанных с удалением:

Copied!
[
	<long>,		/* ID уведомления */
	null
]

Возможные коды ошибок:

Код Описание
7 Ресурс не существует, или у пользователя нет права доступа Создание, редактирование и удаление уведомлений к нему.
6 Неопределенная ошибка.
4 Неверные входные параметры.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.