Read and Review Automation Anywhere Documentation

Automation Anywhere Version 11.3

Close Contents

Contents

Open Contents

Automation Management API

  • Updated: 5/28/2020
    • 11.3.x
    • Explore
    • Enterprise
    • API docs

Automation Management API

Use the Control Room bot Automations API to trigger deployment of bots from an external system or a third-party application.

Automation API

To deploy bots onto the Automation Environment, currently the user has to login to Control Room, select the bot and the Bot Runners and then 'Run/Schedule' the task.

However, as the Automation scenarios scale up, there is an increasing need to deploy/trigger bots from an external third party application.

To meet this business requirement, Automation Anywhere has published Application Programming Interfaces (APIs) using which a bot can be triggered from an external system.

A Control Room user can use these APIs to deploy bots (Tasks) to Bot Runners on commencement of events specified by a third-party/external application.

Note: You cannot deploy Attended bots from the Control Room. Only Unattended bots are available for deployment from the Control Room.

Key Features and Business Benefits of Control Room APIs

  • bots can be deployed from an external third party systems using Automation Anywhere APIs.
  • The input and output of APIs is JSON based (industry standard data-interchange format).
  • bot Deployment can be orchestrated from an External Application / Workflow using a combination of scripts and Automation Anywhere APIs.
Note: The bot deployment API can ONLY be invoked after the system/user has authenticated using the Authentication API

Also, the user will need to have the 'Run my bots' privileges and the privileges of the Bot Runners on which the bot is to be deployed.

Deployment endpoint

The Deployment endpoint is used to deploy bots to Bot Runners.

API: <Control Room URL>/v1/schedule/automations/deploy

The user can pass three parameters as JSON string.

  1. bot name with relative path – This is mandatory.
  2. List of Bot Runners and users in JSON format – This is mandatory.
  3. Use RDP based approach – This is optional and set to false by default.

Deployment Scenario and corresponding JSON string:

  1. For example, the name of the bot is Accountsbot.atmx and the bot is under 'My Tasks'
  2. The bot is to be deployed on 2 machines
    • First machine hostname BR-1 with user U-1
    • Second machine hostname BR-2 with user U-2
  3. The JSON string in the above scenario will be:
    {
      "taskRelativePath": "My Tasks\\AccountsBot.atmx",
      "botRunners":
     [
        {
          "client": "BR-1",
          "user": "U-1"
        },
        {
          "client": "BR-2",
          "user": "U-2"
        }
      ]
    }

Response Codes

Http(s) Status code Response - Description
200 Successful creation of automaton.
400 Bad Request
401 Authentication Required
403 Unauthorized access
409 Conflict
500 Internal Server error
Send Feedback