Работа с правилами событий
Переключение активности правила
Переключает активность правила.
Запрос
Swagger
PUT
/v1/event-rules/{ruleId}/switch/active/{active}Параметры
| Параметр | Тип | Описание |
|---|---|---|
ruleId * (path) | string | ID правила |
active * (path) | boolean | Активность правила |
* - обязательный параметр
Ответ
string
Получение правила по id
Возвращает правило по его id.
Запрос
Swagger
GET
/v1/event-rules/{ruleId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
ruleId * (path) | string | ID правила |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
ruleId | string | uuid | |
name | string | ||
description | string | ||
rules | EventNotificationRules | ||
active | boolean | ||
labels | string[] | ||
creationDate | string | date-time | |
lastUpdateDate | string | date-time |
Редактирование правила
Редактирует правило.
Запрос
Swagger
PUT
/v1/event-rules/{ruleId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
ruleId * (path) | string | ID правила |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
name | string | |
description | string | |
rules | EventNotificationRules | |
active | boolean | |
labels | string[] |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
ruleId | string | uuid | |
name | string | ||
description | string | ||
rules | EventNotificationRules | ||
active | boolean | ||
labels | string[] | ||
creationDate | string | date-time | |
lastUpdateDate | string | date-time |
Удаление правила
Удаляет правило.
Запрос
Swagger
DELETE
/v1/event-rules/{ruleId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
ruleId * (path) | string | ID правила |
* - обязательный параметр
Ответ
string
Переключение активности правил
Переключает активность правил.
Запрос
Swagger
PUT
/v1/event-rules/switch/active/{active}Параметры
| Параметр | Тип | Описание |
|---|---|---|
active * (path) | boolean | Активность правила |
* - обязательный параметр
Ответ
string
Отмена удаления правила
Отменяет удаление правила.
Запрос
Swagger
POST
/v1/event-rules/{ruleId}/cancel-deletionПараметры
| Параметр | Тип | Описание |
|---|---|---|
ruleId * (path) | string | ID правила |
* - обязательный параметр
Ответ
string
Отмена удаления правил
Отменяет удаление правил.
Запрос
Swagger
POST
/v1/event-rules/cancel-deletionОтвет
string
Получение списка правил
Возвращает список всех правил.
Запрос
Swagger
GET
/v1/event-rulesПараметры
| Параметр | Тип | Описание |
|---|---|---|
name (query) | string | Наименование правила |
active (query) | boolean | Активное/неактивное |
labels (query) | array | Лейблы правила |
labelsMode (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 | EventRuleDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Создание правила
Создает правило события.
Запрос
Swagger
POST
/v1/event-rulesТело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
ruleId | string | uuid | |
name | string | ||
description | string | ||
rules | EventNotificationRules | ||
labels | string[] |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
ruleId | string | uuid | |
name | string | ||
description | string | ||
rules | EventNotificationRules | ||
active | boolean | ||
labels | string[] | ||
creationDate | string | date-time | |
lastUpdateDate | string | date-time |
Удаление правила
Удаляет правило.
Запрос
Swagger
DELETE
/v1/event-rulesОтвет
string
Модели
ResponseError
UserParamValue
NotificationTemplate
Throttling
EventNotificationRules
EventRuleDto
EventRuleUpdateRequestDto
PageResponseEventRuleDto
EventRuleCreateRequestDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки