Leia e revise a documentação do Automation Anywhere

Automation Anywhere Automation 360

Fechar conteúdo

Contents (Conteúdo)

Abrir conteúdo

API de programação de automação de lista

  • Atualizado: 2021/01/26
    • Automation 360 v.x
    • Explorar
    • Espaço de trabalho RPA

API de programação de automação de lista

Recupere detalhes das programações de automação que você tem permissões para visualizar.

Pré-requisitos

Nota: Você pode visualizar o Control Room APIs no Community Edition, mas a funcionalidade da API é limitada. Você precisa de uma Automation 360 edição licenciada para acessar a funcionalidade completa das APIs.
  • Use a API de autenticação para gerar um JSON Web Token. Consulte API de autenticação.
  • Você deve receber uma função que inclua a permissão Exibir e gerenciar todas as atividades programadas em Minhas pastas.

Neste exemplo, você lista todas as automações programadas classificadas pela próxima data e hora de execução.

Procedimento

  1. Adicione o token de autenticação ao cabeçalho da solicitação.
  2. Use o método POST e o URL do ponto final: <control_room_url>/v1/schedule/automations/list.
    Corpo da solicitação:
    {
       "sort":[
          {
             "field":"zonedNextRunDateTime",
             "direction":"asc"
          }
       ]
    }
  3. Envie a solicitação.
    Corpo da resposta: A resposta inclui os seguintes dados sobre cada automação:
    • id: o valor numérico que identifica a automação. Use esse parâmetro nas APIs Atualizar automações ou Excluir automações.
    • status: retorna se a automação programada é ACTIVE ou 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
            }
        ]
    }
    A API REST responde a cada solicitação com um código de resposta HTTP. Para códigos de resposta, consulte Códigos de resposta da API.
Send Feedback (Enviar Feedback)