Получение ответа в JSON-формате

Для получения ответа в JSON-формате необходимо отправить запрос с атрибутом format=json вида:

http://<host>:9080/api/<объект>/<сценарий>.ds?<параметры>&format=json

или

https://<host>:9081/api/<объект>/<сценарий>.ds?<параметры>&format=json

где:

<host> — IP-адрес или DNS-имя компьютера с установленным Сервером;

<объект> — объект управления: станция, группа, Сервер, администратор, Карантин.

Доступные сценарии запросов и их параметры приведены в следующих разделах:

•Работа со станциями,

•Работа с группами,

•Работа с Сервером,

•Работа с администраторами,

•Работа с Карантином.

Знак «-» в названии сценария может быть заменен на знак «_». Например, ответы на запросы по сценариям installed-components.ds и installed_components.ds будут идентичны.

JSON-ответ можно получить для любого URL-запроса, поддерживаемого Web API 4.3.0.

JSON-документ содержит следующие основные элементы:

•блок head — служебная информация,

•блок data — ответные данные. Содержимое зависит от выполняемой операции.

Элементы блока head:

Название поля

Описание

status

Статус запроса. Значение true — запрос отработан успешно, false — возникла ошибка, запрос не отработан.

timestamp

Время сервера по GMT (в формате UNIX timestamp)

version в блоке api

Текущая версия Web API

versionString в блоке api

Текущая версия Web API в строковом формате

name в блоке server

Доменное имя или IP-адрес Сервера

version в блоке server

Полная версия Dr.Web Web API для Enterprise Security Suite

uuid в блоке server

Идентификатор Сервера

Если во время выполнения произошла ошибка ("status": false), то в теле ответа присутствует блок error, в котором содержатся текст и код ошибки. Описание ошибки приводится в поле message, код ошибки — в поле code.

{ "head": {
    "status": false,

    "timestamp": 1550867853,

    "api": {
      "version": 40300,
      "versionString": 4.3.0},

    "server": {
      "name": "192.168.1.1",
      "version": "12.00.0.201909260",
      "uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},

"data": {
    "error": {
       "code": 11,
       "message": "Necessary parameters are not specified in your request: 'name'"}}}

Коды ошибок приведены в разделе Возвращаемые коды ошибок.

Во всех элементах всех сценариев Web API 4.3.0 дата и время возвращается в формате Unix timestamp.