フィルターを使用して、特定のフォルダーから Bot を一覧表示する

この例は、特定の Bot を一覧表示するためにフィルターを使用して POST リクエストを送信する方法を示しています。この例では、複数の部門の Bot を含むフォルダーがあります。フィルターを使用して、名前に finance がある Bot だけを返します。

前提条件

JSON Web トークン (JWT)
すべての Control Room API には API にアクセスするための JSON Web トークン (JWT) が必要です。認証 API を使用して認証トークンを生成します。
権限
操作を実行するフォルダーに対する権限が必要です。Control Room インターフェースで Bot が表示できる場合は、この 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/directories/14/files/list

      この URL の例は、[マイ タスク] フォルダーのサブフォルダーを指定しています。

  3. リクエスト本文にフィルター パラメーターを追加します。
    • 結果をアルファベット順に返すには、名前で並べ替えます。
    • 名前フィールドの「finance」文字列でフィルタリングすることにより、名前に finance が含まれるすべての Bot を返します。
    リクエスト本文:
    {
  "sort":[{
    "field":"name",
    "direction":"asc"
  }],
  "filter":{
    "operator":"substring",
    "value":"finance",
    "field":"name"
    },
  "fields":[],
  "page":{ }
}
  4. リクエストを送信します。
    • REST Client で [SEND] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。

    レスポンス本文: この例に対するレスポンスは、名前の中に財務を含む 3 つの Bot についての情報を返します。

    {
  "page": {
    "offset": 0,
    "total": 6,
    "totalFilter": 3
  },
  "list": [
    {
      "id": "27",
      "parentId": "14",
      "name": "finance-new-vendor.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\\Q2\\finance-new-vendor.atmx",
      "directory": false,
      "size": "4602",
      "locked": false,
      "fileLastModified": "2019-12-02T17:38:56Z",
      "isProtected": false
    },
    {
      "id": "31",
      "parentId": "14",
      "name": "financeGenerateInvoice.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\\Q2\\financeGenerateInvoice.atmx",
      "directory": false,
      "size": "5060",
      "locked": false,
      "fileLastModified": "2019-12-02T17:38:56Z",
      "isProtected": false
    },
    {
      "id": "22",
      "parentId": "14",
      "name": "onboardingFinanceOrg.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\\Q2\\onboardingFinanceOrg.atmx",
      "directory": false,
      "size": "3910",
      "locked": false,
      "fileLastModified": "2019-12-02T17:38:56Z",
      "isProtected": false
    }
  ]
}
注: また、コマンド ターミナルから REST リクエストを実行することもできます。これは、Curl リクエストの例です。この例は、読みやすいようにフォーマットされています。角括弧内のテキスト <authentication_token> を認証トークンに置き換えます。
curl -X POST "<your_control_room_url>/v1/repository/directories/14/files/list"
     -H "accept: application/json" -H "X-Authorization: <authentication_token>"
     -H "Content-Type: application/json" -d "{
     \"fields\": [ ],
     \"filter\": {
    	\"operator\": \"substring\",
    	\"field\": \"name\",
    	\"value\": \"finance\" 
	}, 
    \"sort\": [ { 
    	\"field\": \"name\", 
    	\"direction\": \"asc\" 
    } ] 
}"