Pianificare bot l'esecuzione dell'API

Leggi e rivedi la documentazione di Automation Anywhere

Automation 360

Chiudi contenuti

Contenuti

Apri contenuti

Scarica PDF

Pianificare bot l'esecuzione dell'API

Pianificare un bot da eseguire su un incustodito Bot Runner una volta o su base ricorrente.

Prerequisiti

Nota: Puoi visualizzare in Control Room APIs, ma Community Edition la funzionalità API è limitata. È necessaria Automation 360 un'edizione con licenza per accedere alla funzionalità completa delle API.

Utilizza l'API di autenticazione per generare un token Web JSON. Vedere API di autenticazione.
Assicurati di aver allocato le seguenti risorse:
- Visualizza ed esegui l'autorizzazione per la funzionalità I miei bot
- Eseguire e pianificare le autorizzazioni per le cartelle che contengono bots
- Accesso a utenti Bot Runner con licenza
- Accesso a un dispositivo predefinito o a un pool di dispositivi
  Nota: Se all'utente associato alla Bot Runner licenza è stato assegnato un dispositivo predefinito al proprio account, il bot distribuisce su tale dispositivo. Se non è assegnato alcun dispositivo predefinito o si desidera selezionare un dispositivo diverso, è necessario specificare un pool di dispositivi.

Per pianificare un bot, devi fornire le seguenti informazioni all'API :


Parametro	Richiesto	Tipo	Descrizione
ID file	Sì	Numero	Identificatore per . bot Elenca file e cartelle per API di workspace
IDEsegui come utente	Sì	Numero	Identificatore per un utente registrato con Control Room come esecutore di bot non assistito. Elenca API non presidiata disponibile Bot Runners
ID pool	N.	Numero	Identificatore di un pool di dispositivi che ha almeno un dispositivo attivo. Nota: Se all'utente associato alla Bot Runner licenza è stato assegnato un dispositivo predefinito al proprio account, il bot distribuisce su tale dispositivo. Se non è assegnato alcun dispositivo predefinito o si desidera selezionare un dispositivo diverso, è necessario specificare un pool di dispositivi. Elenca API pool di dispositivi

Procedura

Aggiungere il token di autenticazione all'intestazione della richiesta.

Utilizza il metodo POST e l'URL dell'endpoint: <control_room_url>/v1/schedule/automations.

Corpo della richiesta:

Questo corpo della richiesta di esempio contiene i parametri richiesti per pianificare bot un'esecuzione una tantum.

{
   "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"
   }

Questo corpo della richiesta di esempio contiene i parametri necessari per pianificare bot un' da eseguire su base ricorrente.

{
   "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"
}

Inviare la richiesta.

Corpo della risposta: Le due risposte di esempio includono le seguenti informazioni sull'automazione:

id: il valore numerico che identifica l'automazione. Utilizza questo parametro nelle API Update automations (Aggiorna automazioni) o Delete automations (Elimina automazioni).
zonedNextRunDateTime: la data e l'ora della prossima esecuzione bot programmata del .

Questa è una risposta di esempio per un'esecuzione bot pianificata una sola volta.

{
    "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
}

Questa è una risposta di esempio per un'esecuzione bot pianificata su base ricorrente.

{
    "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
}

L'API REST risponde a ogni richiesta con un codice di risposta HTTP. Per i codici di risposta, consulta Codici di risposta API.

Fasi successive

Utilizza API di creazione di elenchi di pianificazioni di automazione per recuperare i dettagli su tutte le automazioni pianificate.

Invia feedback

Automation 360

Pianificare bot l'esecuzione dell'API

Prerequisiti

Procedura

Fasi successive

Feedback