Automation Anywhere ドキュメントを読んで確認する

Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

ワークスペース API 別にファイルとフォルダーを一覧表示

  • 更新済み: 2021/01/19
    • Automation 360 v.x
    • マネージ
    • RPA Workspace
    • API ドキュメント

ワークスペース API 別にファイルとフォルダーを一覧表示

公開または非公開ワークスペースのオブジェクト (ファイル、フォルダー、および Bot) の詳細を返します。このエンドポイントは、ファイル、フォルダー、または Bot を識別するために他の API で使用される数値であるオブジェクト id を返します。

前提条件

注: Community EditionControl Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。
  • すべての API 呼び出しは、リクエスト ヘッダーに認証トークンを含める必要があります。認証 API を使用して JSON Web トークンを生成します。「認証 API」を参照してください。
  • 非公開ワークスペースでオブジェクトを表示するには、[View my bots] 機能権限を含むBot Creatorライセンスとロールが必要です。
  • 公開ワークスペースでオブジェクトを表示するには、公開ワークスペースのフォルダーに対する [View my bots] 機能権限と [View content] Bot 権限を含むロールが割り当てられている必要があります。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
  2. POST メソッドとエンドポイント URL を使用します。 <control_room_url>/v2/repository/workspaces/{workspaceType}/files/list
    {workspaceType} は、公開ワークスペースまたは非公開ワークスペースのどちらで検索するかを指定します。

    次のリクエスト例では、名前に finance の文字を含むオブジェクトを検索します。

    リクエスト本文:
    {
      "filter": {
          "operator": "substring",
          "field": "name",
          "value": "finance"
          }
      }

    サポートされているフィルタ可能なフィールド

  3. リクエストを送信します。
    レスポンス本文:
    このレスポンス例では、エンドポイントはオブジェクト id が 14277 の Bot を返します。
    {
        "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
            }
        ]
        }

    レスポンス パラメーター:

    • id: 検索パラメーターに一致するオブジェクトの一意の数値識別子。
    • parentId: 親フォルダーの一意の数値識別子。
    • folder: オブジェクトがフォルダーの場合は trueBot またはその他のファイルの場合は false を返す boolean 値。
    REST API は、HTTP レスポンス コードで各リクエストに応答します。レスポンス コードの詳細は、「API レスポンス コード」を参照してください。

次のステップ

Bot を実行するステップを実行するか、またはオートメーション スケジュールを作成する場合は、次のタスクを実行します。利用可能な Unattended Bot Runner API のリスト

フィードバックを送る