Rufen Sie API Tasks sofort mit einem Endpunkt auf. Dadurch werden API Tasks bei Bedarf dynamisch gestartet und ausgeführt, indem die Bereitstellungs-API in Verbindung mit der On-Demand-Anforderung verwendet wird. Dieser Ansatz optimiert Workflows und verbessert die Ressourceneffizienz im Vergleich zu herkömmlichen statischen Bereitstellungen.

Anmerkung: API Tasks unterstützt keine interaktiven Formulare.

Wichtigste Vorteile

  • Programmatische Bereitstellung: Stellen Sie API Taskn bei Bedarf von überall aus über Ihren bevorzugten API-Client bereit.
  • Verarbeitung:
    • Automatisierungen werden nur bei Bedarf aktiviert, um eine optimale Ressourcennutzung zu gewährleisten. Das bedeutet, dass sie nicht ständig in der Cloud bereitgestellt werden und Ressourcen blockieren. Stattdessen werden sie bei jeder Anforderung geladen und ausgeführt.
    • In Zeiten hohen Arbeitsaufkommens werden Automatisierungen in eine Warteschlange gestellt und ausgeführt, sobald Geräte verfügbar sind. Das gewährleistet einen reibungslosen Betrieb auch bei hoher Auslastung. Sie können den Fortschritt der Automatisierungen auf der Seite „Aktivität“ einsehen.
    • Mit der Premium-Lizenz können Sie Ihre Automatisierung skalieren und auf einen größeren Pool von Cloud-Ressourcen zugreifen, die mehrere Instanzen Ihrer API Task ausführen können. Das erhöht die Gleichzeitigkeit und ermöglicht es Ihnen, mehr API Task-Anforderungen gleichzeitig zu bearbeiten.
  • Ideale Anwendungsfälle:
    • Stapelverarbeitungsaufträge (z. B. Analyse von Verkaufsdaten, Generieren von Berichten)
    • Geplante Aufgaben
    • Situationen, in denen eine sofortige Reaktion nicht entscheidend ist
Anmerkung: Um eine On-Demand-API Tasknbereitstellung innerhalb eines Prozesses zu ermöglichen, generieren Sie einen Registrierungsschlüssel in Administration > Einstellungen > Bot-Agent-Masseninstallation > Neuen Schlüssel erzeugen und klicken Sie auf Änderungen speichern.

Authentifizieren

Beschaffen Sie die erforderlichen Anmeldedaten, um sich für die Interaktion mit der Bereitstellungs-API zu authentifizieren. Dabei handelt es sich in der Regel um Zugriffstoken oder API-Schlüssel. Mit dem folgenden Beispiel wird eine API Task bei Bedarf auf einem Cloud-Gerät bereitgestellt. Sie können auch Variablen an Bots weiterleiten, wenn sie bereitgestellt werden.

POST https://{{ControlRoomURL}}/v4/automations/deploy

Header: X-Authorization: <<authentication token>> or Authorization: Bearer <<b
earer token>>

Alle API-Aufrufe müssen entweder ein Authentifizierungs-Token der Authentifizierungs-API (generiert JSON-Web-Token) oder ein Bearer-Token von OAuth-Diensten enthalten. Sie können nicht beide zusammen in einer API verwenden.

Erstellen der On-Demand-Anforderung

Anforderung:
{
  "botId": 121,
  "automationName": "SAMPLE_APITASK",
  "description": "My first API Task deploy using api",
  "botLabel": "string",
  "executionType": "RUN_NOW",
  "automationPriority": "PRIORITY_MEDIUM",
  "headlessRequest": {
    "numberOfExecutions": 1,
    "queueOnSlotsExhaustion": false,
    "sharedRunAsUserId": 12
  },
  "botInput": {
    "inputVar": {
      "type": "STRING",
      "string": "PassingString"
    }
  }
}
Anmerkung:

Automatisierungs-Bereitstellungsanforderungen können ganz ohne Eingabefelder erfolgen. Wenn Sie Eingaben angeben, stellen Sie sicher, dass die Variable für den Bot als Eingabe markiert ist, damit die API Task diese zugeordneten Werte erfolgreich empfangen kann. Darüber hinaus muss der Name der Variablen in der API Task mit dem Wert übereinstimmen, der im Anforderungstext zugeordnet wird.

Anforderungsparameter
Parameter Typ Erforderlich Beschreibung
botId Integer Ja Geben Sie die ID der Automatisierung ein, die bereitgestellt werden soll. Die ID ist in der Adressleiste sichtbar, wenn Sie die Automatisierung in einem Editor öffnen.
automationName Zeichenfolge Nein Geben Sie den Namen ein, den Sie verwendet haben, als Sie die Automatisierung erstellt haben.
Beschreibung Zeichenfolge Nein Geben Sie die Beschreibung ein, die Sie verwendet haben, als Sie die Automatisierung erstellt haben.
botLabel Zeichenfolge Nein Geben Sie das Label ein, das Sie bei der Anmeldung der Automatisierung verwendet haben. Sie können Production oder N/A eingeben.
executionType Zeichenfolge Nein Geben Sie den dem Bot zugeordneten Ausführungstyp ein. Sie können einen der folgenden Ausführungstypen eingeben:
  • RUN_NOW
  • RUN_WITH_QUEUE
  • RUN_WITH_EVENT_TRIGGERS
automationPriority Zeichenfolge Nein Geben Sie die Priorität für die Automatisierungsausführung ein. Sie können eine der folgenden Prioritäten eingeben:
  • PRIORITY_MEDIUM
  • PRIORITY_HIGH
  • PRIORITY_LOW
Die Standardpriorität ist als PRIORITY_MEDIUM festgelegt.
headlessRequest-Objekt.
numberOfExecutions Integer Nein Geben Sie die Anzahl der Ausführungen ein, die für eine bestimmte On-Demand-Anforderung (führungslos) durchgeführt werden sollen.
queueOnSlotsExhaustion boolescher Wert Nein Geben Sie True oder False ein, um anzugeben, ob die Bereitstellung in die Warteschlange gestellt werden muss.
sharedRunAsUserId Integer Nein Geben Sie die Nutzer-ID des apitaskrunner-Nutzers ein, um den RunAsUser-Kontext für API Tasks einzurichten.

Die Nutzer-ID ist in der Adressleiste sichtbar, wenn Sie die Nutzerdetails auf der Seite Nutzer bearbeiten bearbeiten.

Weitere Informationen zu apitaskrunner finden Sie unter Run-as-Nutzer für API Task (apitaskrunner).
Anmerkung: Der RunAsUser benötigt keine Bot Runner-Lizenz.
botInput-Objekt
type Beliebig Nein Geben Sie den Typ der Eingabevariablen ein.

Sie können einen der folgenden Variablentypen eingeben: STRING, NUMBER, BOOLEAN, FILE, ITERATOR, LIST, DICTIONARY, TABLE, VARIABLE, CONDITIONAL, WINDOW, TASKBOT, DATETIME, UIOBJECT, RECORD, EXCEPTION, CREDENTIAL, COORDINATE, IMAGE, REGION, PROPERTIES, TRIGGER, CONDITIONALGROUP, FORM, FORMELEMENT, HOTKEY und WORKITEM.
string Zeichenfolge Nein Geben Sie die Zeichenfolge ein, die als Eingabe für die Variable STRING verwendet werden muss.
Antwort 
{
  "deploymentId": "320a2149-aa44-41ab-af9b-f9343ae2581b",
  "automationName": "SAMPLE_APITASK"
}
Antwortparameter
Parameter Typ Beschreibung
deploymentId Zeichenfolge Die Bereitstellungs-ID, die während der Bot-Bereitstellung generiert wird.
automationName Zeichenfolge Der Name der bereitgestellten Automatisierung. Wenn Sie den Automatisierungsnamen nicht in der Anforderung angeben, wird der bereitgestellten Automatisierung ein zufälliger Name zugewiesen.
Sie können diesen Endpunkt in der Swagger-Schnittstelle testen, die in allen Ihren Control Room-Instanzen enthalten ist.
Tipp: Greifen Sie auf Swagger zu, indem Sie zu Ihrer Control Room-Instanz navigieren und am Ende der URL /swagger/ hinzufügen.https://{{ControlRoomURL}}/swagger/

Sehen Sie sich die Aktivitätsseite in Ihrem Control Room an, um den Fortschritt Ihrer (führungslosen) On-Demand-Ausführung zu verfolgen, von In die Warteschlange gestellt >> In Arbeit >> Abgeschlossen.

API-Aufgaben-Aktivitätsseite

Weitere Einzelheiten zur Bereitstellungs-API finden Sie unter Bot-Bot-Bereitstellungs-API (V4).