Работа с триггерами событий
Получение триггера события по его идентификатору
Возвращает триггер события по его идентификатору.
Запрос
Swagger
GET
/v1/event-trigger/{triggerId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
triggerId * (path) | string | Идентификатор триггера |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Имя ресурса | |
triggerId | string | uuid | Идентификатор триггера |
name | string | Имя триггера | |
ruleId | string | uuid | Идентификатор правила, по которому должна произойти рассылка уведомлений |
triggerRules | EventTriggerRulesDto | Правила, по которым работает триггер | |
creationDate | string | date-time | Дата создания триггера |
lastUpdateDate | string | date-time | Дата обновления триггера |
lastTriggeredDate | string | date-time | Последний раз когда сработал триггер |
deletionDate | string | date-time | Дата удаления триггера |
active | boolean | Состояние триггера (работает/не работает) |
Редактирование триггера события
Изменяет триггер события.
Запрос
Swagger
PUT
/v1/event-trigger/{triggerId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
triggerId * (path) | string | Идентификатор триггера |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
name | string | Имя триггера | |
ruleId | string | uuid | Идентификатор правила, по которому должна произойти рассылка уведомлений |
triggerRules | EventTriggerRulesDto | Правила, по которым работает триггер | |
active | boolean | Состояние триггера (работает/не работает) |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Имя ресурса | |
triggerId | string | uuid | Идентификатор триггера |
name | string | Имя триггера | |
ruleId | string | uuid | Идентификатор правила, по которому должна произойти рассылка уведомлений |
triggerRules | EventTriggerRulesDto | Правила, по которым работает триггер | |
creationDate | string | date-time | Дата создания триггера |
lastUpdateDate | string | date-time | Дата обновления триггера |
lastTriggeredDate | string | date-time | Последний раз когда сработал триггер |
deletionDate | string | date-time | Дата удаления триггера |
active | boolean | Состояние триггера (работает/не работает) |
Удаление триггера
Удаляет триггер.
Запрос
Swagger
DELETE
/v1/event-trigger/{triggerId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
triggerId * (path) | string | Идентификатор триггера |
* - обязательный параметр
Ответ
string
Отмена удаления триггера
Отменяет удаление триггера.
Запрос
Swagger
POST
/v1/event-trigger/{triggerId}/cancel-deletionПараметры
| Параметр | Тип | Описание |
|---|---|---|
triggerId * (path) | string | Идентификатор триггера |
* - обязательный параметр
Ответ
string
Получение всех триггеров
Возвращает список триггеров.
Запрос
Swagger
GET
/v1/event-triggerПараметры
| Параметр | Тип | Описание |
|---|---|---|
name (query) | string | Наименование триггера |
pageNumber (query) | integer | |
pageSize (query) | integer | |
sortBy (query) | string | |
order (query) | string |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | EventTriggerDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Создание триггера события
Создает триггер события.
Запрос
Swagger
POST
/v1/event-triggerТело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
triggerId | string | uuid | Идентификатор триггера |
name | string | Имя триггера | |
ruleId | string | uuid | Идентификатор правила, по которому должна произойти рассылка уведомлений |
triggerRules | EventTriggerRulesDto | Правила, по которым работает триггер |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Имя ресурса | |
triggerId | string | uuid | Идентификатор триггера |
name | string | Имя триггера | |
ruleId | string | uuid | Идентификатор правила, по которому должна произойти рассылка уведомлений |
triggerRules | EventTriggerRulesDto | Правила, по которым работает триггер | |
creationDate | string | date-time | Дата создания триггера |
lastUpdateDate | string | date-time | Дата обновления триггера |
lastTriggeredDate | string | date-time | Последний раз когда сработал триггер |
deletionDate | string | date-time | Дата удаления триггера |
active | boolean | Состояние триггера (работает/не работает) |
Модели
EveryDay
EveryWeek
DayAndMonth
WeekAndMonth
EveryMonth
DayAndMonthOfYear
WeekAndMonthOfYear
EveryYear
EventParams
RepeatPeriod
EventTriggerRulesDto
EventTriggerDto
ResponseError
EventTriggerUpdateRequestDto
PageResponseEventTriggerDto
EventTriggerCreateRequestDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки