Управление настройками всех зарегистрированных в ЦУ видов (типов) уведомлений и систем
Получение одной настройки уведомления и системы
Возвращает одну настройку уведомления и системы.
Запрос
Swagger
GET
/v1/systems/{systemId}/notificationTypes/{code}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор настроек уведомлений и системы |
code * (path) | string | Тип уведомлений |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
systemId | string | uuid | Идентификатор сервиса (проекта, приложения) - владельца пользователя |
code | string | Тип уведомлений | |
settings | JsonNode | Метамодель триггера | |
areSettingsCorrect | boolean | Поле сообщающее корректны ли настройки или нет | |
lastUpdateDate | string | date-time | Дата последнего обновления настройки |
creationDate | string | date-time | Дата добавления настройки |
Изменение настроек для уведомления и системы
Изменяет настройки для уведомления и системы.
Запрос
Swagger
PUT
/v1/systems/{systemId}/notificationTypes/{code}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор настроек уведомлений и системы |
code * (path) | string | Тип уведомлений |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
systemId | string | uuid | Идентификатор сервиса (проекта, приложения) - владельца пользователя |
code | string | Тип уведомлений | |
settings | JsonNode | Метамодель триггера | |
areSettingsCorrect | boolean | Поле сообщающее корректны ли настройки или нет | |
lastUpdateDate | string | date-time | Дата последнего обновления настройки |
creationDate | string | date-time | Дата добавления настройки |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
systemId | string | uuid | Идентификатор сервиса (проекта, приложения) - владельца пользователя |
code | string | Тип уведомлений | |
settings | JsonNode | Метамодель триггера | |
areSettingsCorrect | boolean | Поле сообщающее корректны ли настройки или нет | |
lastUpdateDate | string | date-time | Дата последнего обновления настройки |
creationDate | string | date-time | Дата добавления настройки |
Удаление настроек уведомления и системы
Удаляет настройки уведомления и системы.
Запрос
Swagger
DELETE
/v1/systems/{systemId}/notificationTypes/{code}Параметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор настроек уведомлений и системы |
code * (path) | string | Тип уведомлений |
* - обязательный параметр
Ответ
string
Отмена удаления настроек уведомления и системы
Отменяет удаление настроек уведомления и системы.
Запрос
Swagger
POST
/v1/systems/{systemId}/notificationTypes/{code}/cancel-deletionПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор настроек уведомлений и системы |
code * (path) | string | Тип уведомлений |
* - обязательный параметр
Ответ
string
Получение всех настроек уведомления и систем
Возвращает все настройки уведомления и систем.
Запрос
Swagger
GET
/v1/systems/{systemId}/notificationTypesПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | 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 | SettingsNotificationResponseDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Добавление настроек для уведомления и системы
Добавляет настройки для уведомления и системы.
Запрос
Swagger
POST
/v1/systems/{systemId}/notificationTypesПараметры
| Параметр | Тип | Описание |
|---|---|---|
systemId * (path) | string | Идентификатор настроек уведомлений и системы |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
code | string | Тип уведомлений |
settings | JsonNode | Метамодель триггера |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
rn | string | Resource name | |
systemId | string | uuid | Идентификатор сервиса (проекта, приложения) - владельца пользователя |
code | string | Тип уведомлений | |
settings | JsonNode | Метамодель триггера | |
areSettingsCorrect | boolean | Поле сообщающее корректны ли настройки или нет | |
lastUpdateDate | string | date-time | Дата последнего обновления настройки |
creationDate | string | date-time | Дата добавления настройки |
Модели
JsonNode
SettingsNotificationResponseDto
ResponseError
PageResponseSettingsNotificationResponseDto
SettingsNotificationRequestDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки