フィルターを使用した特定のファイルの一覧表示

この例では、検索条件を満たすリポジトリからすべての Bot を返すために、フィルターを使用して POST リクエストを送信する方法を説明しています。この例では、いくつかのフォルダーに test という語を含む Bot があるものとします。名前に test を含む Bot のみを返すフィルターを使用します。

前提条件

JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。
権限
操作を実行するフォルダーに対する権限が必要です。Control Room インターフェースでファイルを表示できる場合は、この API を使用できます。

「ロールの Bot 権限」をご覧ください。

注:
  • API をテストするには、Control Room にインストールされた Swagger 定義ファイルを使用します。利用可能な Swagger API は http://<your_control_room_url>/swagger/ で参照できます。
  • また、REST Client を使用してこのタスクを完了することもできます。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    注: 認証 API を使用して JSON Web トークンを生成します。
  2. メソッドと URL を指定します。
    • メソッド: POST
    • URL: http://<your_control_room_url>/v1/repository/filefolder/list
  3. リクエスト本文にフィルター パラメーターを追加します。
    • 親フォルダーの順序で結果を返すには、parentid で並べ替えます。
    • 名前フィールドで「テスト」サブストリングによってフィルタリングすることで、名前に「test」が含まれるすべてのBotを返します。
    リクエスト本文: 
    {
  "sort":[{
    "field":"parentid",
    "direction":"asc"
  }],
  "filter":{
    "operator":"substring",
    "value":"test",
    "field":"name"
    },
  "fields":[],
  "page":{ }
}
  4. リクエストを送信します。
    • REST Client で [SEND] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。

    レスポンス本文: この例のレスポンスは、リポジトリから 3 つの Bot を返します (1 つは「マイ タスク」フォルダーから、2 つは「Finance」サブフォルダーから)。

    {
  "page": {
    "offset": 0,
    "total": 7,
    "totalFilter": 3
  },
  "list": [
    {
      "id": "14",
      "parentid": "7",
      "name": "testOnboarding.atmx",
      "permission": {
        "delete": false,
        "download": true,
        "execute": false,
        "upload": true,
        "run": false
      },
      "lastModified": "2019-12-02T17:39:05.339Z",
      "lastModifiedBy": "19",
      "path": "Automation Anywhere\\My Tasks\\testOnboarding.atmx",
      "directory": false,
      "size": 4602,
      "locked": false,
      "fileLastModified": "2019-12-02T17:38:56Z",
      "isProtected": false
    },
    {
      "id": "17",
      "parentid": "14",
      "name": "testInvoiceCompare.atmx",
      "permission": {
        "delete": false,
        "download": true,
        "execute": false,
        "upload": true,
        "run": false
      },
      "lastModified": "2019-12-02T17:39:05.339Z",
      "lastModifiedBy": "19",
      "path": "Automation Anywhere\\My Tasks\\Finance\\testInvoiceCompare.atmx",
      "directory": false,
      "size": 4408,
      "locked": false,
      "fileLastModified": "2019-12-02T17:38:56Z",
      "isProtected": false
    },
    {
      "id": "18",
      "parentid": "14",
      "name": "testQuarterlyReport.atmx",
      "permission": {
        "delete": false,
        "download": true,
        "execute": false,
        "upload": true,
        "run": false
      },
      "lastModified": "2019-12-02T17:39:05.339Z",
      "lastModifiedBy": "19",
      "path": "Automation Anywhere\\My Tasks\\Finance\\testQuarterlyReport.atmx",
      "directory": false,
      "size": 4408,
      "locked": false,
      "fileLastModified": "2019-12-02T17:38:56Z",
      "isProtected": false
    }
  ]
}
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X POST "<your_control_room_url>/v1/repository/filefolder/list" -H "accept: application/json"
        -H "X-Authorization: <authentication_token>" -H "Content-Type: application/json"
        -d "{    
            \"sort\": [ {
                \"field\": \"parentid\",
                \"direction\": \"asc\"
            } ],
            \"filter\": {
                \"operator\": \"substring\",
                \"value\": \"test\", 
                \"field\": \"name\" }, 
            \"fields\": [], 
            \"page\": { }
            }"