Как работать с описанием веб-API
Справочник с описанием веб-методов, предоставляемых сервером Docsvision и его расширениями, доступен по адресу http://WebC-server.domain.com:5004/swagger/). Справочник также включает REST Web-API, доступный на стороне клиента Web-клиента, который может вызывать функции Docsvision API (работа с дискреционной безопасностью, карточками, файлами, метаданными и т.д.). API предназначается для работы из клиентских скриптов.
|
Страница Swagger доступна только пользователям из группы DocsVision Administrators. Выполнение запросов недоступно. |
Описание методов сгруппировано по контролёрам, предоставляющим методы.
-
Нажмите на название контролёра, затем по названию метода. Будет раскрыт блок описания.
Рисунок 2. Описание метода "BarcodeSearchButton/{id}"Описание метода включает описание модели возвращаемых данных и перечень параметров метода с примером из модели.