Управление признаками
Изменение признака уведомлений
Изменяет признак уведомления.
Запрос
Swagger
PUT
/v1/systems/{systemId}/flags/{flagName}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
flagName * (path) | string | Имя признака |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
description | string | Описание признака уведомлений |
priority | HIGH | NORMAL | LOW | Уровень приоритета |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
systemId | string | uuid | Идентификатор сервиса (проекта, приложения) - владельца пользователя |
name | string | Наименование признака | |
description | string | Описание признака | |
priority | HIGH | NORMAL | LOW | Уровень приоритета | |
lastUpdateDate | string | date-time | Дата последнего обновления признака |
creationDate | string | date-time | Дата добавления признака |
Получение всех признаков уведомлений системы
Возвращает все признаки уведомлений системы.
Запрос
Swagger
GET
/v1/systems/{systemId}/flagsПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
name (query) | string | Наименование флага |
priorities (query) | array | |
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 | NotificationFlagResponseDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Создание признака уведомления
Создает признак уведомления.
Запрос
Swagger
POST
/v1/systems/{systemId}/flagsПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
name | string | Наименование признака уведомлений |
description | string | Описание признака уведомлений |
priority | HIGH | NORMAL | LOW | Уровень приоритета |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
systemId | string | uuid | Идентификатор сервиса (проекта, приложения) - владельца пользователя |
name | string | Наименование признака | |
description | string | Описание признака | |
priority | HIGH | NORMAL | LOW | Уровень приоритета | |
lastUpdateDate | string | date-time | Дата последнего обновления признака |
creationDate | string | date-time | Дата добавления признака |
Отмена удаления признака уведомления по названию
Отменяет удаление признака уведомления по названию.
Запрос
Swagger
POST
/v1/systems/{systemId}/flags/name/{name}/cancel-deletionПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
name * (path) | string | Наименование флага |
* - обязательный параметр
Ответ
string
Получение признака уведомления по названию
Возвращает признак уведомления по названию.
Запрос
Swagger
GET
/v1/systems/{systemId}/flags/name/{name}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
name * (path) | string | Наименование флага |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
systemId | string | uuid | Идентификатор сервиса (проекта, приложения) - владельца пользователя |
name | string | Наименование признака | |
description | string | Описание признака | |
priority | HIGH | NORMAL | LOW | Уровень приоритета | |
lastUpdateDate | string | date-time | Дата последнего обновления признака |
creationDate | string | date-time | Дата добавления признака |
Удаление признака уведомления по названию
Удаляет признак уведомления по названию.
Запрос
Swagger
DELETE
/v1/systems/{systemId}/flags/name/{name}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор системы |
name * (path) | string | Наименование флага |
* - обязательный параметр
Ответ
string
Модели
NotificationFlagUpdateRequestDto
NotificationFlagResponseDto
ResponseError
PageResponseNotificationFlagResponseDto
NotificationFlagRequestDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки