On-Demand-Endpunkt für API-Aufgaben
- Aktualisiert: 2024/03/18
On-Demand-Endpunkt für API-Aufgaben
Rufen Sie API-Aufgaben sofort mit einem Endpunkt auf. Dadurch werden API-Aufgaben 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.
Wichtigste Vorteile
- Programmatische Bereitstellung: Stellen Sie API-Aufgaben 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-Aufgabe ausführen können. Das erhöht die Gleichzeitigkeit und ermöglicht es Ihnen, mehr API-Aufgabe-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
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-Aufgabe 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/deployHeader: 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
{
"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"
}
}
}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-Aufgabe diese zugeordneten Werte erfolgreich empfangen kann. Darüber hinaus muss der Name der Variablen in der API-Aufgabe mit dem Wert übereinstimmen, der im Anforderungstext zugeordnet wird.
| Parameter | Typ | Erforderlich | Beschreibung |
|---|---|---|---|
| botId | Integer | Ja |
ID der Automatisierung, die bereitgestellt werden soll. |
| automationName | Zeichenfolge | Nein | Name der Automatisierung, die bereitgestellt werden soll. Sie können einen Namen eingeben, um Ihre Automatisierung leicht zu identifizieren. Beispielsweise SAMPLE_APITASK, FIRST_API_TASK, apitask-on-demand. |
| description | Zeichenfolge | Nein | Beschreibung der Automatisierung, die bereitgestellt wird. Beispiel: My first API Task deploy using api |
| botLabel | Zeichenfolge | Nein | Bezeichnung der Automatisierung, die bereitgestellt wird. |
| executionType | Zeichenfolge | Nein | Dem Bot zugeordnete Ausführungsart. |
| automationPriority | Zeichenfolge | Nein | Die Automatisierungspriorität Sie ist standardmäßig auf PRIORITY_MEDIUM gesetzt. Mögliche Werte für die Automatisierungspriorität sind beispielsweise: PRIORITY_MEDIUM, PRIORITY_HIGH und PRIORITY_LOW. |
| headlessRequest-Objekt. | |||
| numberOfExecutions | Integer | Nein | Anzahl der Ausführungen, die für eine bestimmte On-Demand-Anforderung (führungslos) durchgeführt werden. |
| queueOnSlotsExhaustion | boolescher Wert | Nein | Gibt an, ob die Bereitstellung in eine Warteschlange gestellt werden muss. |
| sharedRunAsUserId | Integer | Nein | Der apitaskrunner zum Einrichten des RunAsUser-Kontextes für API-Aufgaben. Weitere Informationen zu apitaskrunner finden Sie unter RunAsUser für API-Task (apitaskrunner). Anmerkung: Für diesen RunAsUser ist keine Bot-Runner-Lizenz erforderlich. |
| botInput-Objekt | |||
| type | Beliebig | Nein | Standardmäßig ist es STRING. Mögliche Werte für den Typ sind beispielsweise 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, and WORKITEM. |
{
"deploymentId": "320a2149-aa44-41ab-af9b-f9343ae2581b",
"automationName": "SAMPLE_APITASK"
}| Parameter | Typ | Beschreibung |
|---|---|---|
| deploymentId | Zeichenfolge | Die Bereitstellungs-ID wurde erstellt. |
| automationName | Zeichenfolge | Name der bereitgestellten Automatisierung. Wenn dieser Name nicht in der Anforderung angegeben wird, wird der bereitgestellten Automatisierung ein zufälliger Name zugewiesen. |
/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.
Weitere Einzelheiten zur Bereitstellungs-API finden Sie unter Bot-Bot-Bereitstellungs-API (V4).