Как работать с описанием веб-API

Справочник с описанием веб-методов, предоставляемых сервером Docsvision и его расширениями, доступен по адресу http://WebC-server.domain.com:5004/swagger/). Справочник также включает REST Web-API, доступный на стороне клиента Web-клиента, который может вызывать функции Docsvision API (работа с дискреционной безопасностью, карточками, файлами, метаданными и т.д.). API предназначается для работы из клиентских скриптов.

Страница описания веб-API
Рисунок 1. Страница описания веб-API

Описание методов сгруппировано по контролёрам, предоставляющим методы.

Чтобы перейти к описанию метода:

  1. Нажмите на название контролёра, затем по названию метода. Будет раскрыт блок описания.

    Описание метода "BarcodeSearchButton/{id}"
    Рисунок 2. Описание метода "BarcodeSearchButton/{id}"

    Описание метода включает описание модели возвращаемых данных и перечень параметров метода с примером из модели.

  2. Если требуется выполнить метод, введите параметры метода в разделе Parameters и нажмите кнопку Try it out!. Ниже будет отображён результат выполнения запроса.

Обратите внимание: методы выполняются в текущей базе данных Web-клиента с правами текущего пользователя веб-браузера.