Leggi e rivedi la documentazione di Automation Anywhere

Automation Anywhre Automation 360

Chiudi contenuti

Contenuti

Apri contenuti

Distribuisci bot API

  • Aggiornato: 2/01/2021
    • Automation 360 v.x
    • Gestisci
    • Spazio di lavoro RPA

Distribuisci bot API

Come utente con una Esecutore di bot licenza, distribuisci bot sui dispositivi assegnati. Puoi anche passare le variabili a bot quando vengono distribuite.

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.
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 bot
  • Accesso a utenti Esecutore di bot con licenza
  • Accesso a un dispositivo predefinito o a un pool di dispositivi
    Nota: Se all'utente associato alla Esecutore di bot 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 distribuire un bot e passare un valore di variabile al bot, devi fornire le seguenti informazioni all'API :

Parametro Richiesto Tipo Descrizione
ID file Numero Identificatore per il bot da distribuire.

Elenca file e cartelle per API di workspace

IDEsegui come utente Numero Identificatore per un utente registrato con Sala di controllo come esecutore di bot non assistito.

Elenca API non presidiata disponibile Bot Runner

ID pool N. Numero Identificatore di un pool di dispositivi che ha almeno un dispositivo attivo.
Nota: Se all'utente associato alla Esecutore di bot 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

ignoraDispositivoPredefinito N. Booleano Se Esecutore di bot l'utente è assegnato a un dispositivo predefinito e desideri specificare un pool di dispositivi, imposta questo parametro su true.

Se si distribuisce al dispositivo predefinito, impostare questo parametro su false.

InputBot N. Varia Specificare il nome della variabile di input, il valore e il tipo di dati.
numOfRunAsUtentiDaUsare N. Numero Specifica il numero Bot Runner da utilizzare dall'elenco di runAsUserIds. Un algoritmo di sistema ponderato seleziona con Bot Runner il minor numero di task in coda.
informazioni di richiamata N. Oggetto Fornisce l'URL e il token di autenticazione per il server di callback. Dopo la bot distribuzione di , Sala di controllo invia lo stato di distribuzione e i valori delle variabili di output a questo server di callback.

Procedura

  1. Aggiungere il token di autenticazione all'intestazione della richiesta.
  2. Utilizzare il metodo POST e l'URL dell'endpoint: <your_control_room_url>/v3/automazioni/distribuzione.

    Corpo della richiesta:

    Questo corpo della richiesta di esempio specifica i parametri richiesti e un valore per una variabile di input.
    {
      "fileId": 14277,
      "runAsUserIds": [
        2538
      ],
      "botInput": {
        "sDocHello": {
          "type": "STRING",
          "string": "Hello world, go be great."
        }
      }
    }
    Questo corpo della richiesta di esempio specifica quattro runAsUserIds e due numOfRunAsUsersToUse. L'algoritmo ponderato seleziona i due con Bot Runner il minor numero di attività in coda al momento della richiesta di distribuzione.
    {
      "fileId": 14277,
      "runAsUserIds": [
        2538,
        4256,
        2213,
        789
      ],
       "poolIds": [
        27
      ],
      "numOfRunAsUsersToUse": 2
    }
    Questo corpo della richiesta di esempio include il valore overrideDefaultDevice impostato su true, quindi verrà bot distribuito nel pool di dispositivi anziché nel dispositivo predefinito dell'utente Run-as-user. Questo esempio contiene anche la sintassi per specificare l'URL del server di callback e fornire l'autorizzazione.
    {
      "fileId": 14277,
      "runAsUserIds": [
        245
      ],
       "poolIds": [
        27
      ],
      "overrideDefaultDevice": true,
      "callbackInfo": {
        "url": "https://callbackserver.com/storeBotExecutionStatus",
        "headers": {
          "X-Authorization": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI0Ii"
        }
      }
    }
  3. Inviare la richiesta.

    Corpo della risposta:

    Quando l'operazione viene eseguita correttamente, l'API di Bot distribuzione restituisce una risposta con l'ID distribuzione.
    {
      "deploymentId": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
    }
    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

Eseguire questa attività: API stato distribuzione bot richiesta.

Invia feedback