Lesen und beachten Sie die Automation Anywhere-Dokumentation

Automation Anywhere Automation 360

Inhalt schließen

Inhalte

Inhalt öffnen

Listen Sie Dateien und Ordner nach Workspace-API auf

  • Aktualisiert: 1/19/2021
    • Automation 360 v.x
    • Managen
    • RPA Workspace
    • API-Dokumente

Listen Sie Dateien und Ordner nach Workspace-API auf

Gibt Details zu Objekten (Dateien, Ordner und Bots) im öffentlichen oder privaten Arbeitsbereich zurück. Dieser Endpunkt gibt die Objekt -idzurück, ein numerischer Wert, der in anderen APIs verwendet wird, um die Datei, den Ordner oder Botzu identifizieren.

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.
  • Um Objekte in Ihrem privaten Arbeitsbereich anzeigen zu können, benötigen Sie eine Bot Creator Lizenz und eine Rolle, die die Berechtigung Meine Bots anzeigen enthält.
  • Um Objekte im öffentlichen Arbeitsbereich anzeigen zu können, muss Ihnen eine Rolle zugewiesen sein, die die Berechtigung Meine Bots anzeigen und die Bot Berechtigung Inhalt anzeigen für Ordner im öffentlichen Arbeitsbereich enthält.

Prozedur

  1. Fügen Sie das Authentifizierungstoken zum Anforderungsheader hinzu.
  2. Verwenden Sie die POST-Methode und die Endpunkt-URL: <Control_room_url>/v2/Repository/Workspaces/{workspaceType}/files/list
    {workspaceType} gibt an, ob im öffentlichen oder privaten Arbeitsbereich gesucht werden soll.

    Die folgende Beispielanforderung sucht nach Objekten, die die Zeichenfolge Finance im Namen enthalten.

    Anforderungsorgan:
    {
      "filter": {
          "operator": "substring",
          "field": "name",
          "value": "finance"
          }
      }

    Unterstützte filterbare Felder

  3. Senden Sie die Anfrage.
    Antwortteil:
    In dieser Beispielantwort gibt dieser Endpunkt einen Bot mit der Objekt -id 14277 zurück.
    {
        "page": {
            "offset": 0,
            "total": 1114,
            "totalFilter": 1
        },
        "list": [
            {
                "id": "14277",
                "parentId": "9",
                "name": "financeWeeklyReport",
                "path": "Automation Anywhere\\Bots\\exampleBots",
                "description": "v1",
                "type": "application/vnd.aa.taskbot",
                "size": "799",
                "folder": false,
                "folderCount": "0",
                "productionVersion": "",
                "latestVersion": "",
                "locked": false,
                "lockedBy": "0",
                "createdBy": "22",
                "lastModifiedBy": "22",
                "lastModified": "2020-10-21T17:42:10.140037Z",
                "permission": {
                    "delete": false,
                    "download": false,
                    "upload": false,
                    "run": true,
                    "publishBotstore": false,
                    "viewContent": false,
                    "clone": false
                },
                "workspaceId": "0",
                "botStatus": "PUBLIC",
                "hasErrors": false,
                "workspaceType": "UNKNOWN",
                "metadata": false,
                "uri": "",
                "version": "3",
                "hasTriggers": false,
                "isModified": false
            }
        ]
        }

    Reaktion Parameter:

    • id: eine eindeutige numerische Kennung für das Objekt, das mit den Suchparametern übereinstimmt.
    • Parentid: eine eindeutige numerische Kennung für den übergeordneten Ordner.
    • Folder: ein boolescher Wert, der true zurückgibt, wenn das Objekt ein Ordner ist, und false , wenn es sich um eine Bot oder eine andere Datei handelt.
    Die REST-API antwortet auf jede Anforderung mit einem HTTP-Antwortcode. Einzelheiten zu den Antwortcodes finden Sie unter API-Antwortcodes.

Nächste Maßnahme

Wenn Sie die Schritte zum Ausführen eines Bot oder zum Erstellen eines Automatisierungsplans ausführen, führen Sie diese Aufgabe aus: Liste verfügbarer unbeaufsichtigter Bot Runners API

Feedback senden