Управление событиями
Получение всех события
Возвращает список событий.
Запрос
Swagger
GET
/v1/eventsПараметры
| Параметр | Тип | Описание |
|---|---|---|
ruleId (query) | string | ID правила |
incomingId (query) | string | ID группы уведомлений |
name (query) | string | Наименование события |
labels (query) | array | Лейблы события |
labelsMode (query) | string | Режим фильтрации лейблов события |
statuses (query) | array | Статусы события |
creationDateFrom (query) | string | |
creationDateTo (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 | EventDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Сообщение о наступлении события
Сообщает о наступлении события.
Запрос
Swagger
POST
/v1/eventsТело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
ruleId | string | uuid | |
name | string | ||
description | string | ||
labels | string[] | ||
properties | JsonNode | Метамодель триггера |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
eventId | string | uuid | |
ruleId | string | uuid | |
status | PENDING | IN_PROGRESS | DONE | ERROR | REJECTED_BY_THROTTLING | ||
name | string | ||
description | string | ||
labels | string[] | ||
properties | JsonNode | Метамодель триггера | |
systemId | string | uuid | |
incomingId | string | uuid | |
creationDate | string | date-time |
Получение списка лейблов
Возвращает список всех лейблов.
Запрос
Swagger
GET
/v1/labelsПараметры
| Параметр | Тип | Описание |
|---|---|---|
name (query) | string | Наименование лейбла |
pageNumber (query) | integer | |
pageSize (query) | integer |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | string[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Получение события по id
Возвращает событие по id.
Запрос
Swagger
GET
/v1/events/{eventId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
eventId * (path) | string | ID события |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
eventId | string | uuid | |
ruleId | string | uuid | |
status | PENDING | IN_PROGRESS | DONE | ERROR | REJECTED_BY_THROTTLING | ||
name | string | ||
description | string | ||
labels | string[] | ||
properties | JsonNode | Метамодель триггера | |
systemId | string | uuid | |
incomingId | string | uuid | |
creationDate | string | date-time |
Получение события по incomingId
Возвращает событие по incomingId.
Запрос
Swagger
GET
/v1/events/incomingId/{incomingId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
incomingId * (path) | string | ID группы уведомлений |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
eventId | string | uuid | |
ruleId | string | uuid | |
status | PENDING | IN_PROGRESS | DONE | ERROR | REJECTED_BY_THROTTLING | ||
name | string | ||
description | string | ||
labels | string[] | ||
properties | JsonNode | Метамодель триггера | |
systemId | string | uuid | |
incomingId | string | uuid | |
creationDate | string | date-time |
Модели
JsonNode
EventDto
PageResponseEventDto
ResponseError
EventRequestDto
PageResponseLabelsDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки