ファイル、フォルダー、および Bot に関する詳細のリクエスト

Bot が保存されている Control Room で名前、相対パス、ID で検索して Bot、フォルダー、およびファイルに関する詳細をリクエストします。

前提条件

Bot の名前、フォルダー パス、および ID を使用して、詳細情報を取得します。
ロールとライセンス

Bot Runner (TaskBot と MetaBot の実行時間) ライセンスを持つユーザーとして認証する必要があります。

  • URL:
    http://<your_control_room_url>/v2/repository/file/list
  • メソッド: POST
サポートされているフィルター可能フィールド:
path
この例では、path パラメーターの文字列 Finance を検索しています。この検索では大文字と小文字は区別されません。Finance または finance が見つかります。
  • フィールド: path
  • タイプ: string
{
  "filter": {
    "operator": "substring",
    "value": "Finance",
    "field": "path"
  }
}
name
名前が「HR」のすべての Bot を取得します。例: Automation Anywhere\My Tasks\Bots\HR-daily.atmx
  • フィールド: name
  • タイプ: string
{
  "filter": {
    "operator": "substring",
    "field": "name",
    "value": "HR"
  }
}
directory
値が false の場合、すべてのファイル (ディレクトリを除く) が取得されます。値が true の場合、すべてのディレクトリが返されます。
  • フィールド: directory
  • タイプ: boolean
{
  "filter": {
    "operator": "eq",
    "field": "directory",
    "value": "false"
  }
}
parentId
parentid が 7 のすべての Bot/ファイルが取得されます。
  • フィールド: parentid
  • タイプ: long
{
  "filter": {
    "operator": "eq",
    "field": "parentid",
    "value": "7"
  }
}
lastModified
その日時に最後に変更された Bot/ファイルがすべて表示されます。
  • フィールド: lastModified
  • タイプ: date-time
{
  "filter": {
    "operator": "gt",
    "field": "lastModified",
    "value": "2022-01-07T18:00:00Z"
  }
}

次のフィールドを使用してレスポンスをフィルターします。

name: Bot の部分名または完全名。Bot の名前に含まれる正確な名前 (eq) またはテキスト文字列 (substring) を検索できます。

次のリクエストは、フォルダー パスに「Finance」を含むフォルダー内にあるすべての Bot の詳細リストを返します。

手順

  1. リクエスト ヘッダーに認証トークンを追加します。
    注: 認証 API を使用して JSON Web トークンを生成します。
  2. API の URL (http://<your_control_room_url>/v2/repository/file/list) を入力します。
  3. POST メソッドを選択します。
  4. リクエスト本文では、substring「finance」を使用して、その文字列を含むフォルダー パスを検索します。 
    {
  "filter": {
    "operator": "substring",
    "field": "path",
    "value": "finance"
  }
}
  5. リクエストを送信します。
    • REST Client で [SEND] をクリックします。
    • Swagger インターフェースで [実行] をクリックします。
    レスポンス本文:

    以下のレスポンス内の id は、Bot の一意な識別子です。このレスポンスでは、2 つの Bot が表示されます。

    {
  "page": {
    "offset": 0,
    "total": 4,
    "totalFilter": 1
  },
  "list": [
    {
      "id": "12",
      "parentid": "11",
      "name": "FinanceHelloWorldGBG.atmx",
      "permission": {
        "delete": false,
        "download": true,
        "execute": false,
        "upload": true,
        "run": false
      },
      "lastModified": "2022-01-08T22:24:08.060Z",
      "lastModifiedBy": "10",
      "path": "Automation Anywhere\\My Tasks\\Finance\\FinanceHelloWorldGBG.atmx",
      "directory": false,
      "size": 4578,
      "locked": false,
      "fileLastModified": "2022-01-08T22:21:58Z",
      "isProtected": false
    }
  ]
}
レスポンス パラメーター
パラメーター タイプ 説明
offset Integer ページネーションに使用される、開始リスト オフセット。
total Integer レコードの合計数。
totalFilter Integer フィルター適用後のレコード数。
リスト 配列 リスト ファイル オブジェクトの配列。
リスト ファイル オブジェクト
id Integer ファイルの一意の ID。
name 文字列 ファイル名。
lastModifiedBy Integer ファイルを最後に変更したユーザーの ID。
path 文字列 ファイルのパス。
size Integer ファイルのサイズ。

次のステップ

特定の Bot をデプロイするには、Bot の数値 id を使用します。詳細な Bot 情報を取得するための追加リクエストがあります。