RESTful Web Api (публичные методы)

Публичные методы универсальны и неизменны между версиями Comindware Business Application Platform.

Каждый метод справа в строке имеет собственное описание, применимое к группе методов, в которой он состоит.

Рассмотрим примеры на один из методов в некоторых группах методов:

• Account – шаблон записей Люди. Для создания пользователя в платформе отправьте запрос POST на адрес http://your-host/webapi/Account. В теле запроса укажите названия атрибутов и их значения в формате json.
• Attribute – атрибуты шаблона записи. Для того чтобы отправить атрибут в архив отправьте запрос PUT на адрес http://your-host/webapi/Attribute/Category/title/Disable, где «Category» - системное имя шаблона записи, «title» - системное имя атрибута.
• Backup – резервное копирование. Для того чтобы удалить созданные сессии необходимо узнать id сессий. Для этого отправьте запрос GET на адрес http://yourhost/webapi/Backup/Session/. Тело запроса должно содержать атрибут {“id”:“backupSession.1”}. Для удаления сессии отправьте запрос DELETE на адрес http://yourhost/webapi/Backup/Session, в теле запроса укажите массив id сессий, например [“backupSession.1”].
• CaseTemplate – шаблон кейса.
• Dataset – список шаблона записи.  
• Document – прикрепленный документ в шаблоне записи. Для того чтобы узнать id документа необходимо первоначально получить все данные по экземпляру записи. Отправьте запрос GET на адрес http://your-host/webapi/Record/1, где «1» — id экземпляра записи. Тело ("Response body") запроса должно содержать атрибут op.10, где «op.10» – системное имя атрибута типа документ, и его значение: {"op.10": [ "document.2" ]}. Для того чтобы скачать документ отправьте запрос GET на адрес http://yourhost/webapi/Document/document.2/Content, где «document.2» - id прикрепленного файла. Тело ("Response body") запроса должно содержать ссылку на скачивание файла.
• DocumentExportTemplate – свойство шаблона записи (раздел Шаблоны).
• Form – свойство шаблона записи (раздел Формы).
• ProcessTemplate – шаблон процесса.
• Record – экземпляр записи. Запросы, связанные с одним экземпляром записи.
• Records – экземпляры записи. Запросы, связанные с несколькими экземплярами записи.
• RecordTemplate – шаблон записи.
• Toolbar – панель инструментов.
• Transfer – операция импорта шаблона записи.
• UserCommand – операции определенного шаблона записи.