Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere

Inhalt schließen

Inhalte

Inhalt öffnen

API zum Abrufen aller Warteschlangen

  • Aktualisiert: 5/10/2019
    • 11.3.x
    • Erkunden
    • Enterprise
    • API-Dokumente

API zum Abrufen aller Warteschlangen

Als Enterprise Control Room-Nutzer mit den Rollenberechtigungen für das Exportieren und Importieren von Bots und Warteschlangenadministratoren können Sie die API zum Abrufen aller Warteschlangen verwenden, um die Liste der Aufgabenelemente aller Warteschlangen und die dafür in Enterprise Control Room verfügbaren Details abzurufen.

Ebenso können Sie als Enterprise Control Room-Nutzer mit den Berechtigungen Exportieren und Bots importieren sowie Warteschlangeneigentümer, Teilnehmer und/oder Verbraucher die API zum Abrufen aller Warteschlangen verwenden, um die Liste der Aufgabenelemente in einer bestimmten Warteschlange und die dafür in Enterprise Control Room verfügbaren Details abzurufen.

API-Endpunkt

Greifen Sie über den folgenden Endpunkt auf die API zu:

<Enterprise Control Room URL>/v1/wlm/queues

Beispiel:

https://crdevenv.com:81/v1/wlm/queues

Abrufen aller Warteschlangen

  1. Verwenden Sie die POST-Methode, um ein Token anhand des Endpunkts https://<Hostname:Port>/v1/authentication zu generieren. Geben Sie hierzu die Enterprise Control Room-Instanz als Servernamen/Hostnamen/IP und die Port-Nummer an.

    Zum Beispiel https://crdevenv.com:81/v1/authentication

  2. Mit der GET-Methode greifen Sie auf Workload-APIs zu.

    Beispiel:

    GET https://crdevenv.com:81/v1/wlm/queues

  3. Geben Sie die folgenden Anfrageparameter in Headern an:

    “X-Authorization” : “Authorization token”

    “Content-Type” : “application/json”

  4. Klicken Sie auf Senden.
  5. Die Aktion war erfolgreich, wenn der Antwortstatus 200 OK lautet.
  6. Sie können die Ergebnisse in den Textkörperdaten anzeigen.

    Beispiel:

    [

    {

    "id": 1, "createdBy": 2, "createdOn": "2018-05-23T16:53:46+05:30", "updatedBy": 2, "updatedOn": "2018-05-24T16:26:02+05:30", "tenantId": 1, "version": 2, "name": "Invoice Queue", "description": "", "reactivationThreshold": 1, "status": "IN_USE", "expiry": null, "manualProcessingTime": null, "manualProcessingTimeUnit": "SECONDS", "workItemProcessingOrders": [ { "id": 3, "priority": 1, "columnId": 2, "sortDirection": "asc" } ], "displayColumnIds": null, "workItemModelId": 1

    },

    {

    "id": 2, "createdBy": 2, "createdOn": "2018-05-25T12:28:36+05:30", "updatedBy": 2, "updatedOn": "2018-05-25T12:28:36+05:30", "tenantId": 1, "version": 0, "name": "Devices for deployment queue", "description": "", "reactivationThreshold": 1, "status": "NOT_IN_USE", "expiry": null, "manualProcessingTime": null, "manualProcessingTimeUnit": "SECONDS", "workItemProcessingOrders": [ { "id": 4, "priority": 1, "columnId": 6, "sortDirection": "asc" } ], "displayColumnIds": null, "workItemModelId": 2

    }

    ]

API-Antwortcodes

Http(s)-Statuscode Antwort/Beschreibung Maßnahme
200 Warteschlangendetails erfolgreich aufgelistet n. v.
400 Fehlerhafter Anfrageparameter Mit gültigen Parametern erneut versuchen
404 Datei nicht gefunden Sicherstellen, dass die Warteschlange in Enterprise Control Room vorhanden ist
501 Berechtigungsfehler Sicherstellen, dass Sie über die erforderliche Berechtigung verfügen
Feedback senden