Automation Anywhere 설명서 읽기 및 검토

Automation 360

콘텐츠 닫기

콘텐츠

콘텐츠 열기

Bot Deploy

  • 업데이트: 2022/04/07
    • Automation 360 v.x
    • 최적화
    • RPA Workspace
    • API 문서

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>>
인증 API를 이용하여 JSON 웹 토큰을 생성합니다. 인증 API를 참고하십시오.
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.

작업 영역 API별로 파일 및 폴더 나열

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.

이용 가능한 무인 Bot Runners API 나열

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.
Note: Bot Runner 라이선스와 연계된 사용자가 자신의 계정에 지정된 기본 기기를 갖고 있는 경우, bot이 그 기기에 배포됩니다. 기본 기기가 지정되지 않았거나, 다른 기기를 선택하려면 기기 풀을 지정해야 합니다.

기기 풀 API 나열

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 API 응답 코드.

{
    "deploymentId": "340a2949-aa44-41ab-af9b-f9343ae2581c"
}

Response Parameters

Parameter Type Description
deploymentId Integer The deployment Id created.
Note: Community Edition에서 Control Room APIs을 볼 수 있지만, API 기능은 제한됩니다. API의 전체 기능에 액세스하려면 라이선스가 인가된 Automation 360 에디션이 필요합니다.
REST API는 HTTP 응답 코드를 이용하여 각 요청에 응답합니다. 응답 코드는 API 응답 코드를 참고하십시오.
피드백을 보내주십시오