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