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

StoragePublisher Access API

Версия 2.1.76

Описание API интерфейса для сервиса StoragePublisher

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

Тип запросаНазваниеОписание
post/services/storagepublisher/api/Project/RemoveByIdПозволяет удалить проект. Удаление проекта происходит путем публикации.
delete/services/storagepublisher/api/Project/RemoveПозволяет удалить проект. Удаление проекта происходит путем публикации.

API для работы с индексами полнотекстового поиска

Тип запросаНазваниеОписание
get/services/storagepublisher/api/Sync/ListIndexesСписок индексов с метаинформацией о классе и сведениями о переиндексации
post/services/storagepublisher/api/Sync/UpdateClassIndexesОбновление индексов OS для классов (пересоздание индекса, переиндексация)

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

Тип запросаНазваниеОписание
post/services/storagepublisher/api/DevTools/CreateMigrationSQLПозволяет сгенерировать sql миграции
post/services/storagepublisher/api/DevTools/CreateTransformationModelПозволяет сгенерировать модель sql миграции
post/services/storagepublisher/api/DevTools/ApplyTransformationModelМетод позволяет проверить критичные изменения перед публикацией
с возможностью подтверждения секций уровня warning (возможная потеря данных)
post/services/storagepublisher/api/DevTools/GetChangeSetПозволяет получить список изменений
post/services/storagepublisher/api/DevTools/CheckOutПозволяет опубликовать модель, и при необходимости провалидировать критичные изменения
post/services/storagepublisher/api/DevTools/GetModelВыдает развернутую и сохраненную devTools-модель
post/services/storagepublisher/api/DevTools/ValidateModelВалидация devTools модели
post/services/storagepublisher/api/DevTools/PublishModelОбновление структуры бд на основе модели DevTools модели
post/services/storagepublisher/api/DevTools/PublishPolicyПубликация rls политик
post/services/storagepublisher/api/DevTools/PublishMetadataПубликация метаданных
post/services/storagepublisher/api/DevTools/SearchMetadataВыполняет поиск по метаданным по заданному фильтру
post/services/storagepublisher/api/DevTools/GetMetadataByIdsПолучение метаданных по идентификатору
post/services/storagepublisher/api/DevTools/ListTargetsПозволяет получить список источников из configmap, доступных для разворачивания модели проекта(ов)

API для публикации и валидации моделей федерации

Тип запросаНазваниеОписание
post/services/storagepublisher/api/FedModel/GetFedModelПолучение текущей модели федерации
post/services/storagepublisher/api/FedModel/PublishFedModelПубликация модели федерации
post/services/storagepublisher/api/FedModel/ValidateFedModelВалидация модели федерации
post/services/storagepublisher/api/FedModel/PublishFedModelFromZipПубликация модели федерации из zip архива
post/services/storagepublisher/api/FedModel/PublishFedModelFromFileПубликация модели федерации из файла (устаревший)
post/services/storagepublisher/api/FedModel/ValidateFedModelFromFileВалидация модели федерации из файла (устаревший)
post/services/storagepublisher/api/FedModel/ValidateFedModelFromZipВалидация модели федерации из zip архива

API для публикации модели из файлов

Тип запросаНазваниеОписание
post/services/storagepublisher/api/PublishStore/PublishFromZipПубликация модели из ахрива-артифакта
post/services/storagepublisher/api/PublishStore/ValidateFromFileВалидация модели из ахрива-артифакта

API для внутреннего мониторинга и тестирования

Тип запросаНазваниеОписание
get/services/storagepublisher/api/CatalogModel/GetModelВнутренний метод получения модели
post/services/storagepublisher/api/CatalogModel/CompareВнутренний метод сравнения
post/services/storagepublisher/api/CatalogModel/PublishВнутренний метод публикации
post/services/storagepublisher/api/CatalogModel/CheckModelПозволяет проверить соответствует ли модель тому, что действительно развернуто в бд

API для работы с конфигурацией федерации

Тип запросаНазваниеОписание
post/services/storagepublisher/api/FedConfiguration/CreateOrUpdateConfigСоздание или обновление конфигурации
post/services/storagepublisher/api/FedConfiguration/DeleteConfigУдаление конфигурации по идентификатору
post/services/storagepublisher/api/FedConfiguration/SearchConfigПоиск конфигурации по фильтру