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

Automation Anywhere Automation 360

コンテンツを閉じる

コンテンツ

コンテンツを開く

特定のフォルダー API 内のファイルとフォルダーを一覧表示する

  • 更新済み: 1/26/2021
    • Automation 360 v.x
    • 管理
    • RPA Workspace
    • API ドキュメント

特定のフォルダー API 内のファイルとフォルダーを一覧表示する

特定の親フォルダー内のオブジェクト (bots、フォルダー、およびファイル) の詳細を返します。このエンドポイントは、ファイル、フォルダー、または bot を識別するために他の API で使用される数値であるオブジェクト ID を返します。

前提条件

注: Community EditionControl Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。
  • 認証 API を使用して JSON Web トークンを生成します。認証 API をご覧ください。
  • プライベート ワークスペースでオブジェクトを表示するには、Bot Creator[マイ Bot の表示] 機能権限を含むライセンスとロールが必要です。
  • パブリック ワークスペースでオブジェクトを表示するには、パブリック ワークスペースのフォルダーに対する [マイ ボットを表示] 機能権限と [コンテンツを表示] bot 権限を含むロールが割り当てられている必要があります。
  • 検索するフォルダーのフォルダ ID が必要です。次のリポジトリ管理 API のいずれかを使用して、オブジェクト ID を取得します。

このタスクの例では、文字列 finance を含むサブフォルダーを検索します。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
  2. POST メソッドとエンドポイント URL: <control_room_url>/v2/repository/folders/{folderId}/list を使用します。
    {folderId} は、検索するフォルダーのオブジェクト ID です。
    リクエスト本文: 次のリクエスト例では、名前に finance の文字を含むフォルダーを検索します。
    {
      "filter": {
        "operator": "and",
        "operands": [
          {
            "operator": "substring",
            "field": "name",
            "value": "finance"
          },
          {
            "operator": "eq",
            "field": "folder",
            "value": "true"
          }
        ]
      }
    }

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

  3. リクエストを送信します。
    レスポンス本文: 正常にリクエストされた場合、このエンドポイントは次のデータを返します。
    • id: 検索パラメーターに一致するオブジェクトの一意の数値識別子。
    • parentId: 親フォルダーの一意の数値識別子です。
    • folder: オブジェクトがフォルダーの場合は truebot またはその他のファイルの場合は false を返す boolean 値。
    このレスポンス例では、エンドポイントはオブジェクト ID が40378のフォルダーを返します。
    {
      "page": {
        "offset": 0,
        "total": 329,
        "totalFilter": 1
      },
      "list": [
        {
          "id": "40378",
          "parentId": "2",
          "name": "EOD-finance-reports",
          "path": "Automation Anywhere\\Bots\\APAC\\EOD-finance-reports",
          "description": "",
          "type": "application/vnd.aa.directory",
          "size": "0",
          "folder": true,
          "folderCount": "0",
          "productionVersion": "",
          "latestVersion": "",
          "locked": false,
          "lockedBy": "0",
          "createdBy": "2587",
          "lastModifiedBy": "2587",
          "lastModified": "2020-09-02T05:26:51.162916Z",
          "permission": {
              "delete": true,
              "download": false,
              "upload": false,
              "run": true,
              "publishBotstore": false,
              "viewContent": true,
              "clone": false,
              "editContent": true,
              "createFolder": true,
              "move": true,
              "cancelCheckout": false,
              "revertCheckout": false
        },
          "workspaceId": "0",
          "botStatus": "DRAFT",
          "hasErrors": false,
          "workspaceType": "UNKNOWN",
          "metadata": false,
          "uri": "",
          "version": "0",
          "hasTriggers": false
        }
      ]
    }
後続の API で id などの数値識別子を使用します。
フィードバックを送る