Методы Solution API

Методы Solution API

Содержание

Введение
Доступ к Solution API
Использование Swagger
Описание методов Solution API

Введение

Solution API предоставляет RESTful-методы, которые автоматически генерируются для всех шаблонов записей, аккаунтов, оргединиц и ролей (но не для шаблонов процессов) в текущем экземпляре Comindware Business Application Platform. Эти методы одинаковы для всех версий Comindware Business Application Platform. Для каждого шаблона предусмотрено пять методов:

удаление записи;
получение данных записи;
изменение данных записи;
получение данных всех записей;
создание записи.

В этой статье представлен обзор методов Solution API. Полную информацию см. в Swagger.

Доступ к Solution API

Базовый URL-адрес для запросов Solution API:
https://your-host/api/public/solution/
Solution API поддерживает запросы GET, PUT, POST, DELETE.
Методы Solution API передают данные в формате JSON.
Solution API поддерживает базовую проверку подлинности.

Использование Swagger

Swagger предоставляет подробную справку по методам API, включая описания запросов и ответов, а также модели данных с примерами значений.

Swagger позволяет выполнять запросы и просматривать ответы.

Интерфейс Swagger для Solution API доступен по адресу:

http://your-host/Docs/SolutionApi

Здесь your-host — доменное имя вашего сервера.

Интерфейс Swagger для метода Solution API, создающего запись в шаблоне

Описание методов Solution API

TemplateSystemName — записи в шаблоне с системным именем TemplateSystemName
Метод	Запрос	Описание	Входные данные	Выходные данные
DELETE	/TemplateSystemName/{id}	Удалить запись из шаблона `TemplateSystemName`	ID записи	Объект статуса
GET	/TemplateSystemName/{id}	Получить данные записи из шаблона `TemplateSystemName`	ID записи	Объект cо значениями атрибутов записи
PUT	/TemplateSystemName/{id}	Изменить данные записи из шаблона `TemplateSystemName`	ID записи и объект cо значениями атрибутов записи	Объект статуса
GET	/ TemplateSystemName	Получить данные всех записей из шаблона `TemplateSystemName`		Массив объектов со значениями атрибутов всех записей
POST	/ TemplateSystemName	Создать запись в шаблоне `TemplateSystemName`	Объект cо значениями атрибутов записи	ID записи