リスト ファイル API
リスト API を使用すると、Control Room 中のすべてのオブジェクト (Bot、フォルダー、ファイル) の詳細を表示できます。レスポンスが正常に完了すると、オブジェクト id が返されます。これは、ファイル、フォルダー、または Bot を識別するために他の API で使用される数値です。
リクエスト
POST http://{{ControlRoolURL}}/v2/repository/file/listHeader: X-Authorization <<authentication token>>- すべての API 呼び出しは、リクエスト ヘッダーに認証トークンを含める必要があります。認証 API を使用して JSON Web トークンを生成します。「認証 API」を参照してください。
- 非公開ワークスペースでオブジェクトを表示するには、[
View my bots] 機能権限を含むBot Creatorライセンスとロールが必要です。 - 公開ワークスペースでオブジェクトを表示するには、公開ワークスペースのフォルダーに対する [
View my bots] 機能権限と [View content] Bot 権限を含むロールが割り当てられている必要があります。
API リクエストは、フィルタ パラメーターを付けても付けなくても送信できます。フィルタ パラメーターを指定しない API リクエストでは、Control Room に含まれるすべてのオブジェクトの詳細を取得します。Control Room に含まれるすべてのオブジェクトを取得するのではなく、フィルタ パラメーターを使用して、特定のファイルまたはフォルダー オブジェクトのセットを取得することができます。詳細については、「フィルタリング、改ページ、ソート」を参照してください。
フィルタなしのリクエスト本文:
{
"fields": [],
"filter": null,
"sort": [
{
"field": "directory",
"direction": "desc"
},
{
"field": "name",
"direction": "asc"
}
],
"page": {
"offset": 0,
"length": 100
}
}フィルタ付きリクエスト本文:
{
"fields": [],
"filter": {
"operator": "substring",
"value": "bot",
"field": "name"
},
"sort": [
{
"field": "directory",
"direction": "desc"
},
{
"field": "name",
"direction": "asc"
}
],
"page": {
"offset": 0,
"length": 100
}
}