Box Developerドキュメント
ログイン
最新バージョン

ごみ箱内のファイルを取得

get
https://api.box.com/2.0
/files/:file_id/trash

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

ごみ箱に移動されたファイルを取得します。

そのファイル自体がごみ箱に移動されている場合のみ、このAPIコールを使用して取得できることに注意してください。そうではなく、その親フォルダのいずれかがごみ箱に移動された場合、GET /folders/:id/trash APIを使用して調べることができるのは、そのフォルダのみです。

ごみ箱に移動されたすべての項目のリストを取得するには、GET /folders/trash/items APIを使用します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

ファイルを表す一意の識別子。

ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。

クエリパラメータ

string arrayクエリ内省略可能
id,type,name

レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。

レスポンス

application/jsonごみ箱内のファイル

ごみ箱に移動された日時の情報を含め、ごみ箱内にあるファイルを返します。

application/jsonクライアントエラー

ファイルがごみ箱で直接見つからない場合にエラーを返します。

そのファイルの親フォルダのいずれかがごみ箱に移動されている場合も、HTTP 404が返されることに注意してください。

その場合、GET /folders/:id/trash APIを使用して調べることができるのは、その親フォルダのみです。

application/jsonクライアントエラー

予期しないクライアントエラー。

get
ごみ箱内のファイルを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/trash" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.trashedFiles.getTrashedFileById(file.id);
Python v10
client.trashed_files.get_trashed_file_by_id(file.id)
.NET v10
await client.TrashedFiles.GetTrashedFileByIdAsync(fileId: file.Id);
Swift v10
try await client.trashedFiles.getTrashedFileById(fileId: file.id)
Java v10
client.getTrashedFiles().getTrashedFileById(file.getId())
.NET v6
await client.TrashedFiles.GetTrashedFileByIdAsync(fileId: file.Id);
Node v4
await client.trashedFiles.getTrashedFileById(file.id);

レスポンスの例

{
  "id": "123456789",
  "type": "file",
  "content_created_at": "2012-12-12T10:53:43-08:00",
  "content_modified_at": "2012-12-12T10:53:43-08:00",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Contract for Q1 renewal",
  "etag": "1",
  "file_version": {
    "id": "12345",
    "type": "file_version",
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  },
  "item_status": "trashed",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "Contract.pdf",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "path_collection": {
    "entries": [
      {
        "etag": "null",
        "id": "123456789",
        "name": "Trash",
        "sequence_id": "null",
        "type": "folder"
      }
    ],
    "total_count": 1
  },
  "purged_at": "2012-12-12T10:53:43-08:00",
  "sequence_id": "3",
  "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
  "shared_link": "null",
  "size": 629644,
  "trashed_at": "2012-12-12T10:53:43-08:00"
}