Работа с конфигурациями сервисов.

/api/config/get

Получить конфигурацию сервиса (без подстановок).

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Параметры запроса.

Название поля	Тип поля	Описание	Обязательное	Возможные значения
serviceName	string	Имя сервиса	нет
configVersion	string	Версия конфигурации	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Конфигурация сервиса (без подстановок)

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	ConfigInfo
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет

/api/config/set

Сохранить изменения в конфигурации сервиса

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Конфигурация сервиса.

Название поля	Тип поля	Описание	Обязательное	Возможные значения
settings	ConfSetting[]	Список конфигурационных параметров	нет
serviceName	string	Имя сервиса	нет
description	string	Описание конфигурации	нет
version	string	Версия конфигурации	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
message	string	Пользовательское сообщение об ошибке.	нет
code	string	Код ошибки.	да
isError	boolean	Признак наличия ошибки.	да
stackTrace	string	Трейс стека вызовов.	нет
innerErrors	IErrorDescription[]	Вложенные исключения.	нет
techMessage	string	Техническое сообщение об ошибке.	нет
dateTime	string (date-time)	Дата и время возникновения ошибки (с часовым поясом).	нет
exceptionType	string	Тип исключения.	нет
source	string	Имя источника.	нет
inners	InnerInfo[]	Элементы исключений.	нет
extra	string	Трейс стека.	нет
id	string	Идентификатор ошибки.	нет
type	ErrorTypes
data	object	Дополнительные данные.	нет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/configurationservice public ConfigController SetConfig(ASE.MD.Platform.Infrastructure.ConfigurationService.Models.ConfigInfo)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/components/securitySchemes/configurationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/api/config/delete

Удалить заданную версию конфигурации для сервиса.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Информация о конфиге.

Название поля	Тип поля	Описание	Обязательное	Возможные значения
serviceName	string	Имя сервиса	нет
configVersion	string	Версия конфигурации	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
message	string	Пользовательское сообщение об ошибке.	нет
code	string	Код ошибки.	да
isError	boolean	Признак наличия ошибки.	да
stackTrace	string	Трейс стека вызовов.	нет
innerErrors	IErrorDescription[]	Вложенные исключения.	нет
techMessage	string	Техническое сообщение об ошибке.	нет
dateTime	string (date-time)	Дата и время возникновения ошибки (с часовым поясом).	нет
exceptionType	string	Тип исключения.	нет
source	string	Имя источника.	нет
inners	InnerInfo[]	Элементы исключений.	нет
extra	string	Трейс стека.	нет
id	string	Идентификатор ошибки.	нет
type	ErrorTypes
data	object	Дополнительные данные.	нет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/configurationservice public ConfigController DeleteConfig(ASE.MD.Platform.Infrastructure.ConfigurationService.Models.ConfigParameter)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/components/securitySchemes/configurationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/api/config/clear

Удалить все конфигурации для сервиса.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Информация о сервисе.

Название поля	Тип поля	Описание	Обязательное	Возможные значения
serviceName	string	Имя сервиса	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Результат выполнения операции

Название поля	Тип поля	Описание	Обязательное	Возможные значения
message	string	Пользовательское сообщение об ошибке.	нет
code	string	Код ошибки.	да
isError	boolean	Признак наличия ошибки.	да
stackTrace	string	Трейс стека вызовов.	нет
innerErrors	IErrorDescription[]	Вложенные исключения.	нет
techMessage	string	Техническое сообщение об ошибке.	нет
dateTime	string (date-time)	Дата и время возникновения ошибки (с часовым поясом).	нет
exceptionType	string	Тип исключения.	нет
source	string	Имя источника.	нет
inners	InnerInfo[]	Элементы исключений.	нет
extra	string	Трейс стека.	нет
id	string	Идентификатор ошибки.	нет
type	ErrorTypes
data	object	Дополнительные данные.	нет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/configurationservice public ConfigController ClearConfigs(ASE.MD.Platform.Infrastructure.ConfigurationService.Models.ServiceInfo)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/components/securitySchemes/configurationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/api/config/load

Загрузить обработанную и готовую к работе конфигурацию сервиса (открытый).

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Информация о ноде сервиса, для которого загружается конфигурация

Название поля	Тип поля	Описание	Обязательное	Возможные значения
serviceName	string	Имя сервиса	нет
configVersion	string	Версия конфигурации	нет
nodeId	string	Идентификатор ноды, которая запрашивает конфигурацию	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Получение окончательной конфигурации сервиса (со всеми подстановками)

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	object	Данные результата метода API.	нет
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/configurationservice public ConfigController LoadConfig(ASE.MD.Platform.Infrastructure.ConfigurationService.Models.LoadParameter)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:load

/components/securitySchemes/configurationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/api/config/take

Загрузить обработанную и готовую к работе конфигурацию сервиса.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Название поля	Тип поля	Описание	Обязательное	Возможные значения
serviceName	string	Имя сервиса	нет
configVersion	string	Версия конфигурации	нет
nodeId	string	Идентификатор ноды, которая запрашивает конфигурацию	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Получение окончательной конфигурации сервиса (со всеми подстановками)

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	object	Данные результата метода API.	нет
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет

Код HTTP ответа: 401

MIME-тип HTTP ответа: text/plain

Unauthorized

Код HTTP ответа: 403

MIME-тип HTTP ответа: text/plain

Forbidden

Схемы авторизации

/components/securitySchemes/configurationservice public ConfigController SecLoadConfig(ASE.MD.Platform.Infrastructure.ConfigurationService.Models.LoadParameter)

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:load

/components/securitySchemes/configurationservice

Тип схемы безопасности: oauth2

Расположение ключа API: cookie

Схема http-авторизации:

URL-адрес OpenId Connect:

Название	Значение
Тип	authorizationCode
Авторизация	/identity/connect/authorize
Выдача токена	/identity/connect/token
Обновление
Области разрешений доступа	config:service:write

/api/config/list

Получить список доступных конфигураций для данного сервиса.

Тип HTTP запроса: post

Отсылаемый запрос

MIME-тип HTTP запроса: application/json

Информация о сервисе.

Название поля	Тип поля	Описание	Обязательное	Возможные значения
serviceName	string	Имя сервиса	нет

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Получения списка конфигураций для сервиса

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	ConfigItem[]	Данные результата метода API.	нет
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет

/api/config/global

Получить список глобальных конфигураций.

Тип HTTP запроса: post

Отсылаемый запрос

Возвращаемые результаты

Код HTTP ответа: 200

MIME-тип HTTP ответа: application/json

Список сервисов с типом "Конфигурация"

Название поля	Тип поля	Описание	Обязательное	Возможные значения
result	GlobalConfigItem[]	Данные результата метода API.	нет
typeInfo	TypeInfo
error	IErrorDescription
isError	boolean	Получает признак наличия ошибки	нет