Для получения ответа в JSON-формате необходимо отправить запрос с дополнительным параметром format=json вида:
https://<host>:9081/api/<объект>/<сценарий>.ds?<параметры>&format=json |
где:
<host> — IP-адрес или DNS-имя компьютера с установленным Сервером Dr.Web;
<объект> — объект управления: станция, группа, Сервер Dr.Web, администратор, Карантин.
Доступные сценарии запросов и их параметры приведены в разделах:
•7. Работа с администраторами,
•8. Работа с группами администраторов.
|
Знак «-» в названии сценария может быть заменен на знак «_». Например, ответы на запросы по сценариям installed-components.ds и installed_components.ds будут идентичны. |
JSON-ответ можно получить для любого HTTP-запроса, поддерживаемого Web API 4.3.2.
JSON-документ содержит следующие основные элементы:
•блок head — служебная информация,
•блок data — ответные данные. Содержимое зависит от выполняемой операции.
Элементы блока head:
Название поля |
Описание |
|---|---|
status |
Статус запроса. Значение true — запрос отработан успешно, false — возникла ошибка, запрос не отработан. |
timestamp |
Время Сервера Dr.Web по GMT (в формате UNIX timestamp) |
version в блоке api |
Текущая версия Web API |
versionString в блоке api |
Текущая версия Web API в строковом формате |
name в блоке server |
Доменное имя или IP-адрес Сервера Dr.Web |
version в блоке server |
Полная версия Dr.Web Enterprise Security Suite |
uuid в блоке server |
Идентификатор Сервера Dr.Web |
Если во время выполнения произошла ошибка ("status": false), то в теле ответа присутствует блок error, в котором содержатся текст и код ошибки. Описание ошибки приводится в поле message, код ошибки — в поле code.
{ "head": { "timestamp": 1579467853, "api": { "server": { "data": { |
См. Приложение В. Возвращаемые коды ошибок, которое содержит перечень кодов ошибок.
Во всех элементах всех сценариев Web API 4.3.2 дата и время возвращается в формате Unix timestamp.