Перейти к основному содержимому

API для работы с моделью в формате devtools

/services/storagepublisher/api/DevTools/CreateMigrationSQL

Позволяет сгенерировать sql миграции

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

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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
projectsProjectWrapper[]нет
configModelConfigWrapper

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

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

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

Success

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController CreateMigrationSQL(ASE.MD.Platform.Infrastructure.Store.DevToolsConverter.Model.ModelWrapper)

Тип схемы безопасности: 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

/services/storagepublisher/api/DevTools/CreateTransformationModel

Позволяет сгенерировать модель sql миграции

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

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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
projectsProjectWrapper[]нет
configModelConfigWrapper

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultTransformationWrapper
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController CreateTransformationModel(ASE.MD.Platform.Infrastructure.Store.DevToolsConverter.Model.ModelWrapper)

Тип схемы безопасности: 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

/services/storagepublisher/api/DevTools/ApplyTransformationModel

Метод позволяет проверить критичные изменения перед публикацией
с возможностью подтверждения секций уровня warning (возможная потеря данных)

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

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

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

Блоки трансформации объединенные в транзакции

Название поляТип поляОписаниеОбязательноеВозможные значения
dateCreatedstring (date-time)нет
versionFromstring (uuid)нет
versionTostring (uuid)нет
transactionContainersSqlTransactionBloc[]нет

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController ApplyTransformationModel(ASE.MD.Platform.Services.Store.StoragePublisher.MigrationSQL.TransformationWrapper)

Тип схемы безопасности: 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

/services/storagepublisher/api/DevTools/GetChangeSet

Позволяет получить список изменений

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

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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
projectsProjectWrapper[]нет
configModelConfigWrapper

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultIDiff[]Данные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController GetChangeSet(ASE.MD.Platform.Infrastructure.Store.DevToolsConverter.Model.ModelWrapper)

Тип схемы безопасности: 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

/services/storagepublisher/api/DevTools/CheckOut

Позволяет опубликовать модель, и при необходимости провалидировать критичные изменения

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

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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
projectsProjectWrapper[]нет
configModelConfigWrapper

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController CheckOut(ASE.MD.Platform.Infrastructure.Store.DevToolsConverter.Model.ModelWrapper)

Тип схемы безопасности: 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

/services/storagepublisher/api/DevTools/GetModel

Выдает развернутую и сохраненную devTools-модель

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

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

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultModelWrapper
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController 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

/services/storagepublisher/api/DevTools/ValidateModel

Валидация devTools модели

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

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

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

DevTool модель

Название поляТип поляОписаниеОбязательноеВозможные значения
projectsProjectWrapper[]нет
configModelConfigWrapper

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultIModelValidationResult
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController ValidateModel(ASE.MD.Platform.Infrastructure.Store.DevToolsConverter.Model.ModelWrapper)

Тип схемы безопасности: 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

/services/storagepublisher/api/DevTools/PublishModel

Обновление структуры бд на основе модели DevTools модели

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

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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
projectsProjectWrapper[]нет
configModelConfigWrapper

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController PublishModel(ASE.MD.Platform.Infrastructure.Store.DevToolsConverter.Model.ModelWrapper)

Тип схемы безопасности: 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

/services/storagepublisher/api/DevTools/PublishPolicy

Публикация rls политик

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

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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
projectsPolicyProjectWrapper[]нет

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController PublishPolicy(ASE.MD.Platform.Infrastructure.Store.DevToolsConverter.Model.PolicyModelWrapper)

Тип схемы безопасности: 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

/services/storagepublisher/api/DevTools/PublishMetadata

Публикация метаданных

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

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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
projectsMetadataProjectWrapper[]нет

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultbooleanДанные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController PublishMetadata(ASE.MD.Platform.Infrastructure.Store.DevToolsConverter.Model.MetadataModelWrapper)

Тип схемы безопасности: 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

/services/storagepublisher/api/DevTools/SearchMetadata

Выполняет поиск по метаданным по заданному фильтру

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

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

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

Название поляТип поляОписаниеОбязательноеВозможные значения
targetIdsstring(uuid)[]нет
targetTypeMetadataTargetType
metadataTypestringнет
namestringнет

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultMetadataItemWrapper[]Данные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController SearchMetadata(ASE.MD.Platform.Infrastructure.Store.Shared.Models.Filters.MetadataFilter)

Тип схемы безопасности: 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

/services/storagepublisher/api/DevTools/GetMetadataByIds

Получение метаданных по идентификатору

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

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

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

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultMetadataItemWrapper[]Данные результата метода API.нет
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController GetMetadataByIds(System.Collections.Generic.List`1[[System.Guid, System.Private.CoreLib, Version=8.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]])

Тип схемы безопасности: 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

/services/storagepublisher/api/DevTools/ListTargets

Позволяет получить список источников из configmap, доступных для разворачивания модели проекта(ов)

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

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

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

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

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

Success

Название поляТип поляОписаниеОбязательноеВозможные значения
resultConfigMapBase
typeInfoTypeInfo
errorIErrorDescription
isErrorbooleanПолучает признак наличия ошибкинет

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

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

Unauthorized

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

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

Forbidden

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

/components/securitySchemes/storagepublisher public DevToolsController ListTargets()

Тип схемы безопасности: 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