Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Request bot deployment status API

  • Updated: 1/12/2021
    • Automation 360 v.x
    • Explore
    • RPA Workspace

Request bot deployment status API

When you deploy a bot you might want to verify the status of the bot deployment. This API enables you to know the deployment status of the bot you deployed.

Prerequisites

Note: You can view the Control Room APIs in the Community Edition, but API functionality is limited. You need a licensed Automation 360 Edition to access the full functionality of the APIs.

Use the Authentication API to generate a JSON Web Token. See Authentication API.

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL: <your_control_room_url>/v2/activity/list.
    To filter your results, you can use the automationId, deviceId, status, or deploymentId. You can also use the combination of these filters to optimize your search results.
    Note: Use the empty filter or no filter to retrieve all the information in the search results.
    The following example search the result using the deploymentId.
    Request body:
    {
      "filter": {
        "operator": "eq",
        "field": "deploymentId",
        "value": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
      }
    }
  3. Send the request.
    Response body: In a successful request, this endpoint returns one of the following deployment status: COMPLETED, UNKNOWN, DEPLOYED, RUNNING, RUN_PAUSED, UPDATE, RUN_FAILED, RUN_ABORTED, RUN_TIMED_OUT, DEPLOY_FAILED, PENDING_EXECUTION, or QUEUED.
    {
        "page": {
            "offset": 0,
            "total": 13,
            "totalFilter": 1
        },
        "list": [
            {
                "id": "e49cea73-01fb-4a10-a7de-ce3e7b83a5ae_0e6c0971292ea185",
                "automationName": "deploy-test_20.05.01.17.08.35_jdoe_API",
                "fileName": "deploy-test",
                "filePath": "Automation Anywhere\\Bots\\deploytest\\deploy-test",
                "type": "TASK",
                "startDateTime": "2020-05-01T17:09:02Z",
                "endDateTime": "2020-05-01T17:09:05Z",
                "command": "",
                "status": "COMPLETED",
                "progress": 100,
                "automationId": "22260",
                "userId": "2538",
                "deviceId": "894",
                "currentLine": 1,
                "totalLines": 1,
                "fileId": "57911",
                "modifiedBy": "2540",
                "createdBy": "2538",
                "modifiedOn": "2020-05-01T17:08:47.657801Z",
                "createdOn": "2020-05-01T17:08:38.228573Z",
                "deploymentId": "14c2b6f8-c2a0-4a57-959d-ef413df0d179",
                "queueName": "",
                "queueId": "",
                "usingRdp": false,
                "message": "",
                "canManage": false,
                "deviceName": "MyCompany-JohnDoe",
                "userName": "jdoe"
            }
        ]
    }
    The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.
Send Feedback