Activity list

Returns a list of bot executions based on filtering, ordering, and pagination rules. Fetches execution details for specific automation IDs as returned by the deployment API, with the exception of bot output variables and callback information.

Nota: If you want to get the botOutVariables or callbackInfo, use Activity job execution.

Request

POST https://{{ControlRoomURL}}/v3/activity/list

Header: X-Authorization <<authentication token>>

All API calls must contain either an authentication token from Authentication API (generates JSON Web token) or a bearer token from OAuth services. You cannot use both together in an API.

Request body:

{
   "sort":[
      {
         "field":"endDateTime",
         "direction":"desc"
      }
   ],
   "filter":{
      "operator":"eq",
      "value":"UPDATE",
      "field":"status"
   },
   "page":{
      "length":100,
      "offset":0
   }
}

Filter the results using automationId, deviceId, status, or deploymentId. You can also use a combination of these filters to optimize your search results.

Request body using deployment ID:

{
  "filter": {
    "operator": "eq",
    "field": "deploymentId",
    "value": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
  }
}

Nota: Use the empty filter or no filter to retrieve all the information in the search results.

Request parameters


Parameter	Type	Required	Description
sort	Array	No	By default, search results are sorted in descending order with respect to their IDs. An alternative sorting is specified using the sort query parameter. Enter the field by which you want to sort along with the direction `asc` (ascending) or `desc` (descending). For more information on sorting, see Filtering, pagination, and sorting.
filter	Object	No	Filters the result. For more information on sorting, see Filtering, pagination, and sorting.
fields	Array	No	Filter the result based on the fields.
page	Object	No	The page object allows you to get the desired pages. For more information on pagination rules, see Filtering, pagination, and sorting.

Response

200 OK

For more information on return codes, see API response codes.

{
    "page": {
        "offset": 0,
        "total": 2387,
        "totalFilter": 2
    },
    "list": [
        {
            "id": "44266e73-4688-4c5a-bad4-11f4c734804d_653a835e07a597fc",
            "automationName": "7 Minutes Bot.22.04.22.13.01.23.chintan-runner",
            "fileName": "7 Minutes Bot",
            "filePath": "",
            "type": "RUN_NOW",
            "startDateTime": "2022-04-22T07:31:44.527762800Z",
            "endDateTime": "1970-01-01T00:00:00Z",
            "command": "",
            "status": "UPDATE",
            "progress": 0,
            "automationId": "",
            "userId": "1141",
            "deviceId": "352",
            "currentLine": 5,
            "totalLines": 0,
            "fileId": "139836",
            "modifiedBy": "1140",
            "createdBy": "1140",
            "modifiedOn": "2022-04-22T07:31:45.265728Z",
            "createdOn": "",
            "deploymentId": "b969e264-65bc-480c-a7db-071bbeedc9ba",
            "queueName": "",
            "queueId": "",
            "usingRdp": false,
            "message": "",
            "canManage": true,
            "deviceName": "AAIN243FQGYE",
            "userName": "joe-doe-runner",
            "tenantUuid": "b6e4eb84-f7ef-4dfd-a432-725b71de8142",
            "automationPriority": "PRIORITY_MEDIUM",
            "callbackInfo": "",
            "runElevated": false,
            "botLabel": "",
            "currentBotName": ""
        },
        {
            "id": "5e55db1e-c6ec-422b-8718-49224b2f3ce3_03a0f7f8bb373597",
            "automationName": "ButtonBot.2022.05.02.08.07.24.ritesh",
            "fileName": "ButtonBot",
            "filePath": "",
            "type": "RUN_NOW",
            "startDateTime": "2022-05-02T15:07:29.004749Z",
            "endDateTime": "1970-01-01T00:00:00Z",
            "command": "",
            "status": "UPDATE",
            "progress": 0,
            "automationId": "",
            "userId": "291",
            "deviceId": "161",
            "currentLine": 0,
            "totalLines": 0,
            "fileId": "142853",
            "modifiedBy": "291",
            "createdBy": "291",
            "modifiedOn": "2022-05-02T08:07:31.548640Z",
            "createdOn": "",
            "deploymentId": "05a192ec-967e-47f3-8b81-185a161d9424",
            "queueName": "",
            "queueId": "",
            "usingRdp": false,
            "message": "",
            "canManage": true,
            "deviceName": "form-builder",
            "userName": "johndoe",
            "tenantUuid": "b6e4eb84-f7ef-4dfd-a432-725b71de8142",
            "automationPriority": "PRIORITY_MEDIUM",
            "callbackInfo": "",
            "runElevated": false,
            "botLabel": "",
            "currentBotName": ""
        }
    ]
}

Response parameters


Parameter	Type	Description
offset	Integer	The starting list offset, used for pagination
total	Integer	Total number of records
totalFilter	Integer	Number of records after applying the filter
List	Array	The array of List activity objects
List activity object
id	Integer	The unique ID of a specific activity
automationName	String	Name of the automation
fileName	String	Bot file name
filePath	String	The file path of the bot Nota: As filePath is deprecated, use Get Immediate Parents API, endpoint: `GET http://{{ControlRoomURL}}/v2/repository/files/{fileid}/parents` to retrieve the file path based on the input file ID.
type	String	File type associated with the bot. Following are the possible values for Type: `TASK`: A regular bot. `RUN_NOW`: A bot that is deployed to be run instantly `WLM_TASK`: A work lifecycle management task `WORKFLOW`: Part of `WLM_TASK`. `WORKORDER`: Part of `WLM_TASK` `AARI`: A process bot
startDate	String	The date and time of when this bot started
endDate	String	The date and time of when this bot ended
command	String	The current command the bot is on
status	String	The status of the bot. Following values are possible: `COMPLETED`: Bot successfully completed execution. `DEPLOYED`: Autologin is successful, and bot is deployed to a device. `DEPLOY_FAILED`: Bot failed to deploy to the device because, for example, autologin failed. `QUEUED`: Requested user or device is busy running another execution `PENDING_EXECUTION`: Device has been selected, but bot has not yet been deployed to that device `RUNNING` or `UPDATE`: Bot is executing on a device. `RUN_FAILED`: Bot failed after being deployed to a device. `RUN_PAUSED`: User paused the bot. `RUN_TIMED_OUT`: Bot failed to complete tasks within a specific time period. `UNKNOWN`: Connection between the service and the device was lost.
progress	Integer	The progress of the bot in percentage.
totalLines	Integer	Total number of command lines the bot contains.
currentLine	Integer	The current line the bot is processing.
timeTaken	Integer	Time taken in milliseconds by the bot to complete the operation.
progress	Integer	The progress of the bot in percentage.
automationId	Integer	The ID of the automation.
userId	Integer	The ID of the user.
deviceId	Integer	The ID of the device.
fileId	Integer	Unique identifier of the bot file.
modifiedBy	Integer	The ID of the user who modified the activity.
createdBy	Integer	The ID of the user who created the activity.
modifiedOn	String	The timestamp when it was modified.
createdOn	String	The creation timestamp of the activity.
deploymentId	String	The deployment ID of the bot.
queueName	String	Name of the queue.
queueId	String	ID of the queue.
usingRdp	Boolean	Flag that shows whether or not the bot is using remote deployment protocol.
message	String	Error message that returns details about the state of the execution.
canManage	Boolean	Flag to show whether the bot can be managed.
deviceName	String	Name of the device.
userName	String	The user name of the user who is running the bot.
tenantUuid	String	The tenant's unique UUID.
automationPriority	String	The automation priority. By default it is set to `PRIORITY_MEDIUM`. Possible values for `automationPriority` include: `PRIORITY_MEDIUM`,`PRIORITY_HIGH`, and `PRIORITY_LOW`.
callbackInfo	Object	No value is returned for this parameter; will need individual bot API to retrieve that information
runElevated	Boolean	Flag showing whether the bot was deployed using elevated permissions or not. Possible values include `false` and `true`.
botLabel	String	Label for the bot. It can be used to distinguish bots from categories such as production and testing.
currentBotName	String	Current name of the bot. It can change during execution.

Nota: 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.

The REST API responds to each request with an HTTP response code. For response codes, see API response codes.