Методы Solution API

Введение

Solution API предоставляет RESTful-методы, которые автоматически генерируются для всех шаблонов записей, аккаунтов, оргединиц и ролей (но не для шаблонов процессов) в текущем экземпляре Comindware Platform. Эти методы одинаковы для всех версий Comindware 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

URL-адрес JSON-спецификации Solution API:

https://your-host/api/public/solution/swagger

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

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

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

TemplateSystemName — записи в шаблоне с системным именем TemplateSystemName

GET	/TemplateSystemName/{id}
Описание	Получает данные записи из шаблона `TemplateSystemName`.
Параметры	ID записи.
Ответ	Объект со значениями атрибутов записи.

PUT	/TemplateSystemName/{id}
Описание	Изменяет данные записи из шаблона `TemplateSystemName`.
Параметры	ID записи и объект со значениями атрибутов записи.
Ответ	Объект статуса.

POST	/TemplateSystemName
Описание	Создает запись в шаблоне `TemplateSystemName`.
Параметры	Объект со значениями атрибутов записи.
Ответ	ID записи.

GET	/TemplateSystemName
Описание	Получает данные всех записей из шаблона `TemplateSystemName`.
Параметры	Не требуются.
Ответ	Массив объектов со значениями атрибутов всех записей.

DELETE	/TemplateSystemName/{id}
Описание	Удаляет запись из шаблона `TemplateSystemName`.
Параметры	ID записи.
Ответ	Объект статуса.