Методы Solution Api
Solution Api Comindware Business Application Platform представляет собой пользовательские методы API, которые автоматически генерируются на основании решения, реализованного на текущей версии Comindware Business Application Platform.
Данный раздел содержит все шаблоны записи и шаблоны пользователя, которые созданы в текущей модели данных.
Для каждого шаблона записи в платформе автоматически генерируются шесть пользовательских методов API, предназначенных для выполнения следующих операций:
- удаление записи;
- получение данных из определенной записи;
- редактирование записи;
- получение данных из всех записей;
- создание записи;
- получение данных из определенного набора отфильтрованных записей.
Список пользовательских методов можно посмотреть по адресу «http://your-host/Docs/SolutionApi», где «your-host» — адрес вашего домена.
Пользовательские методы
В адресах пользовательских методов указывается системное имя шаблона записи.
Использование пользовательских методов будет рассмотрено на примере. Создайте шаблон записи с системным именем «Car» («Машина») и присвойте ему текстовый атрибут «Color» («Цвет»). Используйте пользовательские методы следующим образом:
- Для создания новой записи в шаблоне записи «Car» отправьте запрос «POST» на адрес «http://yourhost/api/public/solution/Car». Тело (body) запроса должно содержать атрибут «Color» и его значение в формате JSON, например, «{"Color":"Red"}» для создания красной машины. В ответ на запрос Comindware Business Application Platform отправит id созданной записи (например, «1»);
- Для редактирования записи в шаблоне записи «Car», отправьте запрос «POST» на адрес «http://yourhost/api/public/solution/Car/1», где «1» — id экземпляра записи. Тело (body) запроса должно содержать атрибут «Color» и его новое значение, например, «{"Color":"Silver"}»;
- Для получения данных из записи, отправьте запрос «GET» на адрес «http://your-host/api/ public/solution/Car/1», где «1» — id записи. В ответ на запрос Comindware Business Application Platform отправит атрибут и его значение в формате JSON, например, «{"Color":"Silver"}».
- Для получения данных из всех записей отправьте запрос «GET» на адрес «http://yourhost/api/public/solution/Car». Comindware Business Application Platform отправит массив, содержащий данные из всех записей в формате JSON.
Номер Статьи: 1846
Размещено: Thu, Jul 1, 2021
Последнее обновление: Fri, Apr 1, 2022
Online URL: https://kb.comindware.ru/article/metody-solution-api-1846.html