Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere Automation 360

Inhalt schließen

Inhalte

Inhalt öffnen

API bereitstellen Bots

  • Aktualisiert: 3/08/2021
    • Automation 360 v.x
    • Managen
    • RPA Workspace

API bereitstellen Bots

Bot Runner Stellen Sie die Bereitstellung Bots als Benutzer mit einer Lizenz auf den zugewiesenen Geräten bereit. Sie können Variablen auch Bots an übergeben, wenn sie bereitgestellt werden.

Vorbereitungen

Anmerkung: Sie können die Control Room APIs im anzeigen Community Edition, aber die API-Funktionalität ist eingeschränkt. Sie benötigen eine lizenzierte Automation 360 Edition, um auf die volle Funktionalität der APIs zugreifen zu können.
Stellen Sie sicher, dass Ihnen die folgenden Ressourcen zugewiesen sind:
  • Meine Bots -Funktion anzeigen und ausführen – Berechtigung
  • Ausführen und Planen von Berechtigungen für die Ordner, die die enthalten Bots
  • Zugriff auf Bot Runner lizenzierte Benutzer
  • Zugriff auf ein Standardgerät oder einen Gerätepool
    Anmerkung: Wenn dem der Bot Runner Lizenz zugeordneten Benutzer ein Standardgerät zugewiesen ist, wird das Bot auf diesem Gerät bereitgestellt. Wenn kein Standardgerät zugewiesen ist oder Sie ein anderes Gerät auswählen möchten, müssen Sie einen Gerätepool angeben.

Um einen bereitzustellen Bot und einen Variablenwert an das Botzu übergeben, geben Sie der API die folgenden Informationen an:

Parameter Erforderlich Typ Beschreibung
fileId Ja Zahl Kennung für das Bot , das bereitgestellt werden soll.

Listen Sie Dateien und Ordner nach Workspace-API auf

RunAsUserIds Ja Zahl Kennung für einen Benutzer, der bei Ihrem Control Room als unbeaufsichtigte bot Runnerregistriert ist.

Liste verfügbarer unbeaufsichtigter Bot Runners API

PoolIds Nein. Zahl Kennung eines Gerätepools, der mindestens ein aktives Gerät hat. Wenn Sie mehrere Pool-IDs eingeben, geben Sie die Werte in der Reihenfolge ein, in der die API nach verfügbaren Geräten suchen soll. Wenn zum Zeitpunkt der Bereitstellung keines der Geräte verfügbar ist, wird die Automatisierung in die Warteschlange gestellt.
Anmerkung: Wenn dem der Bot Runner Lizenz zugeordneten Benutzer ein Standardgerät zugewiesen ist, wird das Bot auf diesem Gerät bereitgestellt. Wenn kein Standardgerät zugewiesen ist oder Sie ein anderes Gerät auswählen möchten, müssen Sie einen Gerätepool angeben.

Auflisten der API für Gerätepools

OverrideDefaultDevice Nein. Boolescher Wert Wenn der Bot Runner Benutzer einem Standardgerät zugewiesen ist und Sie einen Gerätepool angeben möchten, setzen Sie diesen Parameter auf true.

Wenn Sie die Bereitstellung auf dem Standardgerät verwenden, setzen Sie diesen Parameter auf false.

BotInput Nein. Variiert Geben Sie den Namen, den Wert und den Datentyp der Eingabevariablen an.
NumOfRunAsUsersToUse Nein. Zahl Gibt an, wie viele Bot Runners aus der Liste der runAsUserIdsverwendet werden sollen. Ein gewichteter Systemalgorithmus wählt den Bot Runners mit der geringsten Anzahl von Aufgaben in der Warteschlange aus.
CallbackInfo Nein. Objekt Stellt die URL und das Authentifizierungstoken für den Callback-Server bereit. Nachdem das Bot bereitgestellt wurde, sendet das Control Room den Bereitstellungsstatus und die Werte der Ausgabevariablen an diesen Rückrufserver.

Prozedur

  1. Fügen Sie das Authentifizierungstoken zum Anforderungsheader hinzu.
  2. Verwenden Sie die POST-Methode und die Endpunkt-URL: <your_Control_Room_url>/v3/Automatisierungen/Bereitstellen.

    Anforderungsorgan:

    In diesem Beispiel gibt der Request Body die erforderlichen Parameter sowie einen Wert für eine Eingabevariable an.
    {
      "fileId": 14277,
      "runAsUserIds": [
        2538
      ],
      "botInput": {
        "sDocHello": {
          "type": "STRING",
          "string": "Hello world, go be great."
        }
      }
    }
    Dieser Beispiel-Request-Body gibt vier runAsUserIds und zwei numOfRunAsUsersToUsean. Der gewichtete Algorithmus wählt die beiden Bot Runners mit der geringsten Anzahl von Aufgaben aus, die zum Zeitpunkt der Bereitstellungsanforderung in die Warteschlange gestellt wurden.
    {
      "fileId": 14277,
      "runAsUserIds": [
        2538,
        4256,
        2213,
        789
      ],
       "poolIds": [
        27
      ],
      "numOfRunAsUsersToUse": 2
    }
    Dieser Beispiel-Request-Body enthält das auf trueeingestellte OverrideDefaultDevice, sodass das im Bot Gerätepool anstelle des Standardgeräts des Run-as-Benutzers bereitgestellt wird. Dieses Beispiel enthält auch die Syntax zur Angabe der Callback-Server-URL und zur Bereitstellung einer Autorisierung.
    {
      "fileId": 14277,
      "runAsUserIds": [
        245
      ],
       "poolIds": [
        27
      ],
      "overrideDefaultDevice": true,
      "callbackInfo": {
        "url": "https://callbackserver.com/storeBotExecutionStatus",
        "headers": {
          "X-Authorization": "eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI0Ii"
        }
      }
    }
  3. Senden Sie die Anfrage.

    Antwortgremium:

    Nach erfolgreichem Abschluss gibt die Bot Bereitstellungs-API eine Antwort mit der Bereitstellungs-IDzurück.
    {
      "deploymentId": "14c2b6f8-c2a0-4a57-959d-ef413df0d179"
    }
    Die REST-API antwortet auf jede Anforderung mit einem HTTP-Antwortcode. Antwortcodes finden Sie unter API-Antwortcodes.

Nächste Maßnahme

Führen Sie diese Aufgabe aus: Bot-Bereitstellungsstatus-API anfordern.

Feedback senden