Управление настройками пользователя
Создание/перезапись настроек пользователя
Создает/перезаписывает настройки пользователя. Если ключ настройки уже имеется в базе, тогда будет перезаписан, иначе создан.
Запрос
Swagger
PUT
/v2/user-settings/user/{userId}/profile/{profileId}/type/{notificationType}Параметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
profileId * (path) | string | Идентификатор профиля |
notificationType * (path) | string | Тип уведомления |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
UserSettingsEmailDto | UserSettingsEmailDto | |
UserSettingsGapsDto | UserSettingsGapsDto | |
UserSettingsPushDto | UserSettingsPushDto | |
UserSettingsSmsDto | UserSettingsSmsDto | |
UserSettingsMattermostDto | UserSettingsMattermostDto | |
UserSettingsTelegramDto | UserSettingsTelegramDto |
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
profileId | string | ||
notificationType | string | ||
creationDate | string | date-time | |
lastUpdateDate | string | date-time | |
data | JsonNode | Метамодель триггера |
Создание/перезапись настроек пользователя полностью
Создает/перезаписывает множественные настройки пользователя. Если ключ настройки уже имеется в базе, тогда будет перезаписан, иначе создан. Если в базе есть ключ, которого нет в запросе, он будет удален.
Запрос
Swagger
POST
/v2/user-settings/user/{userId}/profile/{profileId}/type/{notificationType}Параметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
profileId * (path) | string | Идентификатор профиля |
notificationType * (path) | string | Тип уведомления |
* - обязательный параметр
Ответ
| Параметр | Тип | Формат | Описание |
|---|---|---|---|
profileId | string | ||
notificationType | string | ||
creationDate | string | date-time | |
lastUpdateDate | string | date-time | |
data | JsonNode | Метамодель триггера |
Удаление настроек
Удаляет настройки.
Запрос
Swagger
DELETE
/v2/user-settings/user/{userId}/profile/{profileId}/type/{notificationType}Параметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
notificationType * (path) | string | Тип уведомления |
profileId * (path) | string | Идентификатор профиля |
settingsKey (query) | string |
* - обязательный параметр
Ответ
string
Получение настроек пользователя
Возвращает настройки пользователя.
Запрос
Swagger
GET
/v2/user-settings/user/{userId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
notificationType.eq (query) | string | |
profileId.eq (query) | string | |
settingsKey.eq (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 | ProfileContainerViewDto[] | Записи | |
sortBy | string | Поле для сортировки | |
order | ASC | DESC | Порядок сортировки |
Создание/перезапись множественных настроек пользователя
Создает/перезаписывает множественные настройки пользователя.
Запрос
Swagger
POST
/v2/user-settings/user/{userId}Параметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
* - обязательный параметр
Тело запроса
| Параметр | Тип | Описание |
|---|---|---|
profileId | string | Идентификатор из мастер-системы |
notificationType | string | Тип уведомления |
settingsKeys | object | Настройки профиля |
Отмена удаления настроек
Отменяет удаление настроек.
Запрос
Swagger
POST
/v2/user-settings/user/{userId}/profile/{profileId}/type/{notificationType}/cancel-deletionПараметры
| Параметр | Тип | Описание |
|---|---|---|
userId * (path) | string | Идентификатор пользователя |
notificationType * (path) | string | Тип уведомления |
profileId * (path) | string | Идентификатор профиля |
* - обязательный параметр
Ответ
string
Модели
UserSettingsEmailDto
UserSettingsGapsDto
UserSettingsPushDto
UserSettingsSmsDto
UserSettingsWebhookDto
UserSettingsMattermostDto
UserSettingsTelegramDto
UserSettingsOneOfDto
JsonNode
ProfileContainerViewDto
ResponseError
PageResponseProfileContainerViewDto
ApiUserSettingsRequestDto
В демопримерах реализованы стандартные сценарии, демонстрирующие работу отдельных сервисов Платформы ГосТех. Отправка тестовых запросов в демопримерах позволит вам ознакомиться с функциями того или иного сервиса. Доступные демопримеры и описания реализованной в них функциональности представлены ниже.
Центр уведомлений
Регистрация пользователей и настройка их каналов связи. Отправка уведомлений (с заданным шаблоном или без), отслеживание статуса доставки