RunPluginCommand

Назначение	Отправка команды плагину Агента
Тип запроса	Асинхронный/синхронный
Поддерживаемая версия агента	v2
PluggetSystemType	Plugin

Формат запроса

{
    "taskType": "RunPluginCommand",
    "params": {
      "async": {
        "objectId": number,
         "timeout": number
      },
      "sync": {
        "objectId": number,
         "timeout": number
      },
        "pluginName": "string",
        "pluginParams": object
    }
}

JSON

Параметр	Тип	Обязательный	Описание
taskType	string	да	Тип задачи, для данного метода значение RunPluginCommand
-async			Асинхронный вызов метода: либо синхронный, либо асинхронный
-sync			Синхронный вызов метода: либо синхронный, либо асинхронный
--timeout	int	нет	Время ожидания ответа от агента в секундах. По умолчанию — 120 секунд
--objectId	int	да	Код ресторана в системе лицензирования
pluginName	string	да	Название плагина, которому адресована команда
pluginParams	object	да	Json-объект, который передаётся плагину без разбора на уровне Агента

Формат синхронного ответа

{ 
   "responseCommon":{ 
      "taskGuid":"guid",
      "taskType":"RunPluginCommand",
      "objectId":number
   },
   "error":{ 
      "wsError":{ 
         "code":"string",
         "desc":"string"
      }
   }
}

JSON

Параметр	Тип	Описание
-taskGuid	guid	Уникальный код этой задачи. Используется при получении задачи через очередь
-taskType	string enum	Тип задачи
-objectId	int	Код ресторана в системе лицензирования
error		Контейнер ошибок, подробнее читайте в статье Описание ошибок

Формат асинхронного ответа

{
    "taskResponse": object,
    "responseCommon": {
        "taskGuid": "guid",
        "taskType": "RunPluginCommand",
        "objectId": "number"
    },
    "error": {
        "wsError": {
            "code": "string",
            "desc": "string"
        },
        "agentError": {
            "code": "string",
            "desc": "string"
        }
    }
}

JSON

Параметр	Тип параметра	Описание
taskResponse	object	Json, сериализованный из результата обработки команды плагином
error		Контейнер ошибок, подробнее читайте в статье Описание ошибок