ServiceGetMultiAgentInfo

Purpose	Gets multi-agent parameters
Request type	Asynchronous
Supported agent version	v2.мультиагент
PluggetSystemType	AgentInternal

Request format

JSON

{
"taskType": "ServiceGetMultiAgentInfo",
"params": {}
}

Parameter	Type	Mandatory	Description
taskType	string	yes	Task type. For this method, the value is ServiceGetMultiAgentInfo

Response format

Successful response

JSON

{
   "responseCommon":{
      "taskGuid":"guid",
      "taskType":"ServiceGetMultiAgentInfo",
      "agentGuid": "guid"
   },
   "taskResponse":{
      "objectList":[int],
      "supportedTaskTypes":["string enum"]
   },
   "error":{
      "wsError":{
         "code":"string",
         "desc":"string"
      }
   }
}

Parameter	Type	Description
-taskGuid	guid	Unique code for this task. Used when receiving a task via the queue
-taskType	string enum	Task type
-agentGuid	guid string	Multi-agent identifier
-objectList	array of int	List of objectIds that the multi-agent can work with
-supportedTaskTypes	array of string enums	List of Tasks supported by the multi-agent. Read more in the article White Server API v2
error		Error container, for more details see the article Error Description

Response with access error

JSON

{
  "responseCommon": {
    "taskGuid": "34398dc7-5488-49d1-a499-fef9e8826f40",
    "taskType": "ServiceGetMultiAgentInfo",
    "agentGuid": "guid"
  },
  "error": {
    "wsError": {
      "code": "AuthFailed"
    }
  }
}