Zeitplan Bot für die Ausführung der API

Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere Automation 360

Inhalt schließen

Inhalte

Inhalt öffnen

PDF herunterladen

Zeitplan Bot für die Ausführung der API

Planen Sie einen für Bot die einmalige Bot Runner oder wiederkehrende Ausführung unbeaufsichtigt ein.

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.

Verwenden Sie die Authentifizierungs -API, um ein JSON-Webtoken zu generieren.
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 zu planen Bot, geben Sie die folgenden Informationen an die API an:


Parameter	Erforderlich	Typ	Beschreibung
fileId	Ja	Zahl	Kennung für das Bot. 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
status	Ja	Zeichenfolge	Gibt an, ob ein aktiver Zeitplan oder ein Entwurfszeitplan erstellt werden soll. Geben Sie entweder `AKTIV` oder `ENTWURF`ein.
PoolIds	Nein.	Zahl	Kennung eines Gerätepools, der mindestens ein aktives Gerät hat. 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

Prozedur

Fügen Sie das Authentifizierungstoken zum Anforderungsheader hinzu.

Verwenden Sie die POST-Methode und die Endpunkt-URL: <Control_Room_url>/v1/Schedule/Automations.

Anforderungsgremium:

Dieser Beispielanforderungskörper enthält die erforderlichen Parameter, um eine Bot einmalige Ausführung zu planen.

{
   "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",
   "status":"ACTIVE"
   }

Dieser Beispielanforderungskörper enthält die erforderlichen Parameter, um eine Bot wiederkehrende Ausführung zu planen.

{
   "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",
   "status":"ACTIVE"
}

Senden Sie die Anfrage.

Antwortteil: Die beiden Beispielantworten enthalten die folgenden Informationen über die Automatisierung:

id: der numerische Wert, der die Automatisierung identifiziert. Verwenden Sie diesen Parameter in den APIs „Automatisierungen aktualisieren“ oder „Automatisierungen löschen“.
ZonedNextRunDateTime: Datum und Uhrzeit der nächsten geplanten Ausführung des. Bot

Dies ist eine Beispielantwort für eine Bot geplante einmalige Ausführung.

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

Dies ist eine Beispielantwort für eine Bot planmäßige Ausführung auf wiederkehrender Basis.

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

Die REST-API antwortet auf jede Anforderung mit einem HTTP-Antwortcode. Antwortcodes finden Sie unter API-Antwortcodes.

Nächste Maßnahme

Verwenden Sie, API für Automatisierungszeitpläne auflisten um Details zu allen geplanten Automatisierungen abzurufen.

Feedback senden