API для внутреннего мониторинга и тестирования
/api/CatalogModel/GetModel
Внутренний метод получения модели
Тип HTTP запроса: get
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | IDataModel | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | IDataModel | |||
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/storagepublisher public CatalogModelController GetModel()
Тип схемы безоп асности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | store:model:read |
/components/securitySchemes/storagepublisher
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | store:model:read, store:model:write |
/api/CatalogModel/Compare
Внутренний метод сравнения
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| projects | IProjectModel[] | нет | ||
| metadataProvider | IMetaDataProvider | |||
| policyProvider | IPolicyProvider | |||
| version | string (uuid) | нет | ||
| state | ModelState | |||
| deployed | string (date-time) | нет | ||
| localServiceName | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/storagepublisher public CatalogModelController Compare(ASE.MD.Platform.Infrastructure.Store.Shared.Models.Model.Struct.DataModel)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | store:model:read |
/components/securitySchemes/storagepublisher
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | store:model:read, store:model:write |
/api/CatalogModel/Publish
Внутренний метод публикации
Тип HTTP запроса: post
Отсылаемый запрос
MIME-тип HTTP запроса: application/json
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| projects | IProjectModel[] | нет | ||
| metadataProvider | IMetaDataProvider | |||
| policyProvider | IPolicyProvider | |||
| version | string (uuid) | нет | ||
| state | ModelState | |||
| deployed | string (date-time) | нет | ||
| localServiceName | string | нет |
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/storagepublisher public CatalogModelController Publish(ASE.MD.Platform.Infrastructure.Store.Shared.Models.Model.Struct.DataModel)
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | store:model:write |
/components/securitySchemes/storagepublisher
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | store:model:read, store:model:write |
/api/CatalogModel/CheckModel
Позволяет проверить соответствует ли модель тому, что действительно развернуто в бд
Тип HTTP запроса: post
Отсылаемый запрос
Возвращаемые результаты
Код HTTP ответа: 200
MIME-тип HTTP ответа: text/plain
Success
| Название поля | Тип поля | Описание | Обязательное | Возможные значения |
|---|---|---|---|---|
| result | boolean | Данные результата метода API. | нет | |
| typeInfo | TypeInfo | |||
| error | IErrorDescription | |||
| isError | boolean | Получает признак наличия ошибки | нет |
Код HTTP ответа: 401
MIME-тип HTTP ответа: text/plain
Unauthorized
Код HTTP ответа: 403
MIME-тип HTTP ответа: text/plain
Forbidden
Схемы авторизации
/components/securitySchemes/storagepublisher public CatalogModelController CheckModel()
Тип схемы безопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | store:model:write |
/components/securitySchemes/storagepublisher
Тип схемы бе зопасности: oauth2
Расположение ключа API: cookie
Схема http-авторизации:
URL-адрес OpenId Connect:
| Название | Значение |
|---|---|
| Тип | authorizationCode |
| Авторизация | /identity/connect/authorize |
| Выдача токена | /identity/connect/token |
| Обновление | |
| Области разрешений доступа | store:model:read, store:model:write |