Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere

Inhalt schließen

Inhalte

Inhalt öffnen

API zum Abrufen einer Liste aller Aufgabenelemente einer Warteschlange

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

API zum Abrufen einer Liste aller Aufgabenelemente einer Warteschlange

Automation Anywhere enthält eine REST-API, mit der Sie eine Liste der Aufgabenelemente für eine Warteschlange sowie die zugehörigen Details aus Enterprise Control Room abrufen können. Diese Liste kann verwendet werden, um das Ergebnis eines Aufgabenelements über eine Chat-Anwendung an Kunden weiterzugeben.

API-Endpunkt

Als Enterprise Control Room-Nutzer mit der Rolle Warteschlangenadministrator oder Warteschlangeneigentümer und/oder Verbraucherberechtigungen können Sie die API zum Abrufen aller Warteschlangen verwenden, um auf eine Liste von Aufgabenelementen einer bestimmten Warteschlange zuzugreifen.

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

<Enterprise Control RoomURL>/v2/wlm/queues/<queue-id>/workitems/list

Beispiel:

https://crdevenv.com:81/v2/wlm/queues/1/workitems/list 

Auflisten aller Warteschlangen

  1. Verwenden Sie die POST-Methode, um ein Token anhand des Endpunkts
    http(s)://<hostname:port>/v1/authentication
    zu generieren. Geben Sie hierzu die Enterprise Control Room-Instanz als Servernamen/Hostnamen/IP und die Portnummer an. Beispiel:
    https://crdevenv.com:81/v1/authentication
  2. Verwenden Sie die GET-Methode, um auf die Workload-API und die Aufgabenelemente in einer bestimmten Warteschlange zuzugreifen. Beispiel:
    POST https://crdevenv.com:81/v2/wlm/queues/1/workitems/list 
  3. Geben Sie die folgenden Anfrageparameter in Headern an:
    "X-Authorization" : "Authorization Token" "Content-Type": "application/json"
  4. Geben Sie die folgenden Parameter im Textkörper der Anfrage an: Beispiel:
    { "sort": [ ], "filter": { "operator": "or", "operands": [ { "field": "id", "operator": "eq", "value": "1" }, { "field": "id", "operator": "eq", "value": "2" } ] }, "fields": [ ], "page": { "length": 200, "offset": 0 } }
  5. Die Aktion war erfolgreich, wenn der Antwortstatus wie folgt lautet:
    200 OK

    Sie können die Ergebnisse in den Textkörperdaten anzeigen. Beispiel:

    { "page": { "offset": 0, "total": 16, "totalFilter": 2 }, "list": [ { "id": 1, "createdBy": 2, "createdOn": "2019-01-23T23:03:36.339Z", "updatedBy": 2, "updatedOn": "2019-01-23T23:03:36.339Z", "tenantId": 1, "version": 0, "json": "{"Invoice ID":"IN0001","Customer Name ":"Jason Goodman","Amount":400000,"Email":"jason@aae.com","Invoice Date":"12-03-2019"}", "result": "", "deviceId": 0, "status": "Ready to run", "col1": "IN0001", "col2": "", "col3": "", "col4": "", "col5": "", "brUserId": 0, "queueId": 1, "comment": "", "botId": 0, "poolId": 0, "automationId": 0, "totalPausedTime": "0" }, { "id": 2, "createdBy": 2, "createdOn": "2018-08-23T23:03:36.361Z", "updatedBy": 2, "updatedOn": "2018-08-23T23:03:36.361Z", "tenantId": 1, "version": 0, "json": "{"Invoice ID":"IN0002","Customer Name ":"Ellie Brown","Amount":700000,"Email":"ellie@aae.com","Invoice Date":"12-03-2019"}", "result": "", "deviceId": 0, "status": "Ready to run", "col1": "IN0002", "col2": "", "col3": "", "col4": "", "col5": "", "brUserId": 0, "queueId": 1, "comment": "", "botId": 0, "poolId": 0, "automationId": 0, "totalPausedTime": "0" } ] }

API-Antwortcodes

Http(s)-Statuscode Antwort/Beschreibung Maßnahme
200 Aufgabenelemente erfolgreich aufgelistet n. v.
400 Fehlerhafter Anfrageparameter Mit gültigen Parametern erneut versuchen
401 Authentifizierung erforderlich Authentifizierungsparameter angeben
403 Nicht autorisierter Zugriff Authentifizierungsparameter für Nutzer mit Zugriffsrechten angeben
404 Datei nicht gefunden Sicherstellen, dass die Warteschlange in Enterprise Control Room vorhanden ist
500 Interner Serverfehler Sicherstellen, dass die Serververbindung verfügbar ist
Feedback senden