Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

List automation schedules API

  • Updated: 8/10/2021
    • Automation 360 v.x
    • Explore
    • RPA Workspace

List automation schedules API

Retrieve details of the automation schedules that you have permissions to view.

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.
  • You must be assigned a role that includes the View and manage all scheduled activity from my Folders permission.

In this example, you list all the scheduled automations sorted by the next run date and time.

Procedure

  1. Add the authentication token to the request header.
  2. Use the POST method and endpoint URL: <control_room_url>/v1/schedule/automations/list.
    Request body:
    {
       "sort":[
          {
             "field":"zonedNextRunDateTime",
             "direction":"asc"
          }
       ]
    }
  3. Send the request.
    Response body: The response includes the following data about each automation:
    • id: the numerical value that identifies the automation. Use this parameter in the Update automations or Delete automations APIs.
    • status: returns whether the scheduled automation is ACTIVE or INACTIVE.
    {
        "page": {
            "offset": 0,
            "total": 3,
            "totalFilter": 3
        },
        "list": [
            {
                "id": "661",
                "name": "eodReport_28.20.10.12.23.02.48",
                "fileId": 6598,
                "status": "ACTIVE",
                "deviceIds": [],
                "description": "",
                "rdpEnabled": false,
                "scheduleType": "DAILY",
                "dailyRecurrence": {
                    "interval": 3
                },
                "timeZone": "America/Los_Angeles",
                "startDate": "2020-10-12",
                "endDate": "",
                "startTime": "23:30",
                "repeatEnabled": true,
                "repeatOccurrence": {
                    "runEvery": "3",
                    "timeUnit": "HOURS",
                    "endTime": "23:59"
                },
                "zonedNextRunDateTime": "2021-01-14T07:30:00Z",
                "createdBy": "251",
                "createdOn": "2020-10-13T06:01:51.992433Z",
                "updatedBy": "251",
                "updatedOn": "2021-01-11T07:30:00.082057Z",
                "tenantId": "1",
                "fileName": "wlm_28",
                "filePath": "Automation Anywhere\\Bots\\West Coast",
                "runAsUserIds": [
                    "251"
                ],
                "botInput": {},
                "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                "poolId": [
                    "23"
                ],
                "overrideDefaultDevice": false,
                "runElevated": false
            },
            {
                "id": "990",
                "name": "accounts.20.12.16.10.51.59",
                "fileId": 12501,
                "status": "ACTIVE",
                "deviceIds": [],
                "description": "",
                "rdpEnabled": false,
                "scheduleType": "WEEKLY",
                "weeklyRecurrence": {
                    "interval": 1,
                    "daysOfWeek": [
                        "TUE",
                        "THU",
                        "FRI"
                    ]
                },
                "timeZone": "Australia/Melbourne",
                "startDate": "2021-01-16",
                "endDate": "2021-12-24",
                "startTime": "20:45",
                "repeatEnabled": true,
                "repeatOccurrence": {
                    "runEvery": "1",
                    "timeUnit": "HOURS",
                    "endTime": "23:59"
                },
                "zonedNextRunDateTime": "2021-01-19T09:45:00Z",
                "createdBy": "1103",
                "createdOn": "2021-01-11T18:59:31.182663Z",
                "updatedBy": "1103",
                "updatedOn": "2021-01-11T18:59:31.182669Z",
                "tenantId": "1",
                "fileName": "a_trigger",
                "filePath": "Automation Anywhere\\Bots\\APAC",
                "runAsUserIds": [
                    "80",
                    "36",
                    "1103"
                ],
                "botInput": {},
                "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                "poolId": [
                    "7"
                ],
                "overrideDefaultDevice": false,
                "runElevated": false
            },
            {
                "id": "989",
                "name": "UpdateInventory.20.12.16.10.40.48",
                "fileId": 11201,
                "status": "ACTIVE",
                "deviceIds": [],
                "description": "",
                "rdpEnabled": false,
                "scheduleType": "NONE",
                "timeZone": "Asia/Calcutta",
                "startDate": "2021-12-16",
                "endDate": "",
                "startTime": "15:00",
                "repeatEnabled": false,
                "zonedNextRunDateTime": "2021-12-16T09:30:00Z",
                "createdBy": "1103",
                "createdOn": "2021-01-11T18:57:18.932407Z",
                "updatedBy": "1103",
                "updatedOn": "2021-01-11T18:57:18.932422Z",
                "tenantId": "1",
                "fileName": "appsheet",
                "filePath": "Automation Anywhere\\Bots\\spreadsheets",
                "runAsUserIds": [
                    "480",
                    "80",
                    "472"
                ],
                "botInput": {},
                "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
                "poolId": [
                    "11"
                ],
                "overrideDefaultDevice": false,
                "runElevated": false
            }
        ]
    }
    The REST API responds to each request with an HTTP response code. For response codes, see API response codes.
Send Feedback