Leia e revise a documentação do Automation Anywhere

Automation Anywhere Automation 360

Fechar conteúdo

Contents (Conteúdo)

Abrir conteúdo

Programação bot para executar API

  • Atualizado: 2021/01/28

    Programação bot para executar API

    Programe um bot para ser executado sem supervisão Bot Runner uma vez ou de forma recorrente.

    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.

    Para programar um bot, você fornece as seguintes informações à API do :

    Parâmetro Obrigatório Digite Descrição
    ID do arquivo Sim Número Identificador para o bot. Listar pastas e arquivos de espaços de trabalho
    IdsUsuárioExecução Sim Número Identificador de um usuário registrado no Control Room como um executor de bots não assistido. Como encontrar um id de usuário
    IDs de piscina No Número Identificador de um grupo de dispositivos que tem pelo menos um dispositivo ativo. Listar grupos de dispositivos

    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.
      Corpo da solicitação:
      Este corpo de solicitação de exemplo contém os parâmetros necessários para programar um bot para ser executado uma vez.
      {
         "name":"UpdateInventory.20.12.16.10.40.48",
         "fileId":"14277",
         "poolIds":[
            "27"
         ],
         "timeZone":"Asia/Calcutta",
         "runAsUserIds":[
            "472",
            "480",
            "80"
         ],
         "startDate":"2020-12-16",
         "startTime":"15:00",
         "scheduleType":"NONE"
         }
      Este corpo de solicitação de exemplo contém os parâmetros necessários para programar um bot para ser executado de forma recorrente.
      {
         "name":"UpdateInventory.20.12.16.10.40.48",
         "fileId":"14277",
         "poolIds":[
            "27"
         ],
         "timeZone":"Australia/Melbourne",
         "runAsUserIds":[
            "1103",
            "36",
            "80"
         ],
         "startDate":"2020-12-16",
         "repeatOccurrence":{
            "endTime":"23:59",
            "runEvery":"1",
            "timeUnit":"HOURS"
         },
         "repeatEnabled":true,
         "endDate":"2020-12-24",
         "startTime":"20:45",
         "weeklyRecurrence":{
            "interval":"1",
            "daysOfWeek":[
               "TUE",
               "THU",
               "FRI"
            ]
         },
         "scheduleType":"WEEKLY"
      }
    3. Envie a solicitação.
      Corpo da resposta: As duas respostas de exemplo incluem as seguintes informações sobre a 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.
      • zonedNextRunDateTime: a data e hora da próxima vez que o bot está programado para execução.
      Este é um exemplo de resposta para uma bot programada para ser executada uma vez.
      {
          "id": "989",
          "name": "UpdateInventory.20.12.16.10.40.48",
          "fileId": "14277",
          "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\\appsheet",
          "runAsUserIds": [
              "480",
              "80",
              "472"
          ],
          "botInput": {},
          "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
          "poolId": [
              "11"
          ],
          "overrideDefaultDevice": false,
          "runElevated": false
      }
      Este é um exemplo de resposta para um bot programado para ser executado de forma recorrente.
      {
          "id": "990",
          "name": "UpdateInventory.20.12.16.10.40.48",
          "fileId": "14277",
          "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\\a_trigger",
          "runAsUserIds": [
              "80",
              "36",
              "1103"
          ],
          "botInput": {},
          "tenantUuid": "e100fbce-008c-04ec-4063-7af0af91fb2f",
          "poolId": [
              "7"
          ],
          "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.

    Próximas etapas

    Use o API de programação de automação de lista para recuperar detalhes sobre todas as automações programadas.
    Send Feedback (Enviar Feedback)