Bot Deploy

Leia e revise a documentação do Automation Anywhere

Automation 360

Contents (Conteúdo)

Baixar PDF

Bot Deploy

As a user with a Bot Runner license, deploy bots on your assigned devices. You can also pass variables to bots when they are deployed.

Request

POST https://{{ControlRoomURL}}/v3/automations/deploy

Header: X-Authorization <<authentication token>>

Use a API de autenticação para gerar um JSON Web Token. Consulte API de autenticação.

Request body with LIST input:

{
  "fileId": 86, 
  "runAsUserIds": [
    3 
  ],
  "poolIds": [],
  "overrideDefaultDevice": false,
  "callbackInfo": {
    "url": "https://callbackserver.com/storeBotExecutionStatus", 
    "headers": {
      "X-Authorization": "{{token}}" 
    }
  },
  "botInput": { 
    "iTestList": {
      "type": "LIST", //Type can be [ STRING, NUMBER, BOOLEAN, LIST, DICTIONARY, DATETIME ]
     "list": [
        { "type":"STRING",
         "string": "TestValues1" 
    },
     { "type":"STRING",
         "string": "TestValues2" 
    }
     ] //key must match type, in this case string
    }
  }
}

Request body with STRING input:

{
  "fileId": 87,
  "runAsUserIds": [
    3 
  ],
  "poolIds": [],
  "overrideDefaultDevice": false,
  "callbackInfo": {
    "url": "https://callbackserver.com/storeBotExecutionStatus", 
    "headers": {
      "X-Authorization": "{{token}}" 
    }
  },
  "botInput": { 
    "sInput1": {
      "type": "STRING", 
      "string": "Test Values1" 
    },
    "sInput2": {
      "type": "STRING",
      "string": "Test Values2"
    }
  }
}

Request body with DICTIONARY input:

{
  "fileId": 86, 
  "runAsUserIds": [
    3 
  ],
  "botInput": { 
    "iTestList": {
      "type": "DICTIONARY", //Type can be [ STRING, NUMBER, BOOLEAN, LIST, DICTIONARY, DATETIME ]
     "dictionary": [
         {
            "key":"key1",
            "value":{
               "type":"STRING",
               "string":"value1"
            }
         },
         {
            "key":"key2",
            "value":{
               "type":"STRING",
               "string":"value2"
            }
         }
      ] //key must match type, in this case string
    }
  }
}

Request body with DATE TIME input:

{
  "fileId": 87,
  "runAsUserIds": [
    3 
  ],
  "botInput": { 
    "dt_input": {
      "type": "DATETIME", 
      "string": "2022-04-07T00:15:00-06:00[USA/New York]" 
    },
    "dt_input": {
      "type": "DATETIME",
      "string": "2022-04-07T00:15:05-06:00[USA/New York]"
    }
  }
}

Request Parameters


Parameter	Type	Required	Description
fileId	Integer	Yes	File Id of bot to be deployed. Listar pastas e arquivos de espaços de trabalho
automationName	String	No	Name of the automation to be deployed.
runAsUserIds	Integer	Yes	List of runAs user ids to deploy bot. The bot will be deployed on associated default device for each `runAsUserIds` or on one of the devices from the device pool(s), if provided. Como encontrar um id de usuário
callbackInfo	Object	No	CallbackInfo Provides the callback API URL and authentication token for the callback server. After the bot is deployed, the Control Room sends the deployment status and output variable values to this callback server.
poolIds	Integer	No	Identifier of a device pool that has at least one active device. If you enter multiple pool IDs, enter the values in the order of which you want the API to check for available devices. If none of the devices are available at the time of deployment, the automation is queued. Listar grupos de dispositivos
overrideDefaultDevice	Boolean	No	If the Bot Runner user is assigned to a default device and you want to specify a device pool, set this parameter to `true`. If deploying to the default device, set this parameter to `false`.
runElevated	Array	No	Whether to deploy the bot using elevated permissions or not. Possible values include - `false`, `true`.
numOfRunAsUsersToUse	Integer	No	Specifies how many Bot Runners to use from the list of runAsUserIds provided. A weighted system algorithm selects the Bot Runners with the least number of queued tasks. System will pick the specified number of `runAsUsers` with the least number of tasks queued for the user at the moment of deploy request. If 0 then all the users will be used. If the number is greater than the number of `runAsUsers` provided or less than 0 it will error out.
automationPriority	String	No	The automation Priority. By default it is set to `PRIORITY_MEDIUM`. Possible values for `automationPriority` includes: `PRIORITY_MEDIUM`,`PRIORITY_HIGH`, and `PRIORITY_LOW`.
botLabel	String	No	Label for the bot to be deployed.
botInput	Object	No	A data structure containing a botInput Object. See below for more details.
botInput Object
type*	String	No	By default it is `STRING`. Possible values for `type` includes: `STRING`, `NUMBER`, `BOOLEAN`, `FILE`, `ITERATOR`, `LIST`, `DICTIONARY`, `TABLE`, `VARIABLE`, `CONDITIONAL`, `WINDOW`, `TASKBOT`, `DATETIME`, `UIOBJECT`, `RECORD`, `EXCEPTION`, `CREDENTIAL`, `COORDINATE`, `IMAGE`, `REGION`, `PROPERTIES`, `TRIGGER`, `CONDITIONALGROUP`, `FORM`, `FORMELEMENT`, `HOTKEY`, and `WORKITEM`.
*The structure of the input varies depending on the type you want to input. This topic provides you with few of the mostly used sample.

Response

200 OK

For more information on the return codes, see