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

Automation 360

コンテンツ

PDF をダウンロード

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

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

前提条件

注: Community Edition で Control Room APIs を表示できますが、API 機能は制限されています。API のすべての機能にアクセスするには、Automation 360 のライセンス版が必要です。

認証 API を使用して JSON Web トークンを生成します。認証 API をご覧ください。
プライベートワークスペースでオブジェクトを表示するには、Bot Creator[マイ Bot の表示] 機能権限を含むライセンスとロールが必要です。
パブリックワークスペースでオブジェクトを表示するには、パブリックワークスペースのフォルダーに対する [マイボットを表示] 機能権限と [コンテンツを表示] bot 権限を含むロールが割り当てられている必要があります。

bot 名、フォルダーパス、ID などのフィルターを使用して、結果を絞り込むことができます。サポートされているフィルター可能フィールド

手順

リクエストヘッダーに認証トークンを追加します。
POST メソッドとエンドポイント URL: <control_room_url>/v2/repository/file/listを使用します。
リクエスト本文: 次のリクエスト例では、パスに finance の文字列を含むオブジェクトを検索します。
```
{
  "filter": {
    "operator": "substring",
    "field": "path",
    "value": "finance"
  }
}
```

リクエストを送信します。

レスポンス本文: 次のレスポンス内の [ID] は、bot の一意な識別子です。

このレスポンス例では、エンドポイントはオブジェクト id が 12 の 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": "2020-01-08T22:24:08.060Z",
      "lastModifiedBy": "10",
      "path": "Automation Anywhere\\My Tasks\\Finance\\FinanceHelloWorldGBG.atmx",
      "directory": false,
      "size": 4578,
      "locked": false,
      "fileLastModified": "2020-01-08T22:21:58Z",
      "isProtected": false
    }
  ]
}

REST API は、HTTP レスポンスコードで各リクエストに応答します。レスポンスコードの詳細は、API レスポンスコードを参照してください。

フィードバックを送る