Управление шаблонами уведомлений
Редактирование шаблона и его связей
Изменяет шаблон и его связи.
Запрос
Swagger
PUT
/v1/templates/{id}/with-linksПараметры
| Параметр | Тип | Описание |
|---|---|---|
id * (path) | string | ID шаблона |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
name | string | Наименование шаблона |
content | string | Тело шаблона |
types | string[] | Типы уведомлений для связи |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
id | string | uuid | Идентификатор шаблона |
rn | string | Resource name | |
name | string | Наименование шаблона | |
content | string | Контент шаблона | |
types | string[] | Тип уведомления | |
params | string[] | Параметры шаблона | |
creationDate | string | date-time | Дата создания системы |
lastUpdateDate | string | date-time | Дата последнего обновления настройки |
Получение шаблона
Возвращает шаблон уведомления.
Запрос
Swagger
GET
/v1/templates/{id}Параметры
| Параметр | Тип | Описание |
|---|---|---|
id * (path) | string | ID шаблона |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
id | string | uuid | Идентификатор шаблона |
rn | string | Resource name | |
name | string | Наименование шаблона | |
content | string | Контент шаблона | |
types | string[] | Тип уведомления | |
params | string[] | Параметры шаблона | |
creationDate | string | date-time | Дата создания системы |
lastUpdateDate | string | date-time | Дата последнего обновления настройки |
Редактирование шаблона
Изменяет шаблон уведомлений.
Запрос
Swagger
PUT
/v1/templates/{id}Параметры
| Параметр | Тип | Описание |
|---|---|---|
id * (path) | string | ID шаблона |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
name | string | Наименование шаблона |
content | string | Тело шаблона |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
id | string | uuid | Идентификатор шаблона |
rn | string | Resource name | |
name | string | Наименование шаблона | |
content | string | Контент шаблона | |
types | string[] | Тип уведомления | |
params | string[] | Параметры шаблона | |
creationDate | string | date-time | Дата создания системы |
lastUpdateDate | string | date-time | Дата последнего обновления настройки |
Удаление шаблона
Удаляет шаблон уведомлений.
Запрос
Swagger
DELETE
/v1/templates/{id}Параметры
| Параметр | Тип | Описание |
|---|---|---|
id * (path) | string | ID шаблона |
* - обязательный параметр
Отмена удаления шаблона
Отменяет удаление шаблона уведомлений.
Запрос
Swagger
POST
/v1/templates/{id}/cancel-deletionПараметры
| Параметр | Тип | Описание |
|---|---|---|
id * (path) | string | ID шаблона |
* - обязательный параметр
Создание шаблона co связями
Создает шаблон со связями.
Запрос
Swagger
POST
/v1/templates-with-linksТело запроса
| Параметр | Тип | Описание |
|---|---|---|
name | string | Наименование шаблона |
content | string | Тело шаблона |
types | string[] | Типы уведомлений для связи |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
id | string | uuid | Идентификатор шаблона |
rn | string | Resource name | |
name | string | Наименование шаблона | |
content | string | Контент шаблона | |
types | string[] | Тип уведомления | |
params | string[] | Параметры шаблона | |
creationDate | string | date-time | Дата создания системы |
lastUpdateDate | string | date-time | Дата последнего обновления настройки |
Получение всех шаблонов
Возвращает список всех шаблонов.
Запрос
Swagger
GET
/v1/templatesПараметры
| Параметр | Тип | Описание |
|---|---|---|
name (query) | string | Наименование шаблона |
pageNumber (query) | integer | |
pageSize (query) | integer | |
types (query) | array | |
sortBy (query) | string | |
order (query) | string |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
totalElements | integer | int64 | Количество записей |
pageSize | integer | int32 | Размер страницы |
currentPage | integer | int32 | Текущая страница |
totalPages | integer | int32 | Количество страниц |
content | TemplateDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Создание шаблона
Создание шаблона уведомлений.
Запрос
Swagger
POST
/v1/templatesТело запроса
| Параметр | Тип | Описание |
|---|---|---|
name | string | Наименование шаблона |
content | string | Тело шаблона |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
id | string | uuid | Идентификатор шаблона |
rn | string | Resource name | |
name | string | Наименование шаблона | |
content | string | Контент шаблона | |
types | string[] | Тип уведомления | |
params | string[] | Параметры шаблона | |
creationDate | string | date-time | Дата создания системы |
lastUpdateDate | string | date-time | Дата последнего обновления настройки |
Модели
ContentWithTypesDto
TemplateDto
ResponseError
ContentDto
PageResponseTemplateDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки