メインコンテンツへスキップ
GET
/
files
/
{file_id}
/
trash
cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/trash" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
{
  "id": "123456789",
  "type": "file",
  "sequence_id": "3",
  "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
  "description": "Contract for Q1 renewal",
  "size": 629644,
  "path_collection": {
    "total_count": 1,
    "entries": [
      {
        "type": "folder",
        "id": "123456789",
        "sequence_id": null,
        "etag": null,
        "name": "Trash"
      }
    ]
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "item_status": "trashed",
  "etag": "1",
  "name": "Contract.pdf",
  "file_version": {
    "id": "12345",
    "type": "file_version",
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  },
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "purged_at": "2012-12-12T10:53:43-08:00",
  "content_created_at": "2012-12-12T10:53:43-08:00",
  "content_modified_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "name": "Aaron Levie",
    "login": "ceo@example.com"
  },
  "shared_link": null,
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developer.box.com/llms.txt

Use this file to discover all available pages before exploring further.

このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

​
Authorization
string
header
必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

​
file_id
string
必須

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

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

クエリパラメータ

​
fields
string[]

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

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

レスポンス

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

ごみ箱内のファイルを表します。

​
id
string
必須

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

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

例:

"123456789"

​
type
enum<string>
必須

値は常にfileになります。

利用可能なオプション:
file
例:

"file"

​
sequence_id
string | null
必須

この項目に適用された最新のUser Eventを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。

たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。

例:

"3"

​
sha1
string<digest>
必須

ファイルのSHA1ハッシュ。Box上のファイルとローカルファイルの内容を比較する目的に使用できます。

例:

"85136C79CBF9FE36BB9D05D0639C70C265C18D37"

​
description
string
必須

このファイルの説明 (省略可)。

Maximum string length: 256
例:

"Contract for Q1 renewal"

​
size
integer
必須

ファイルサイズ (バイト単位)。この整数を解析する際には、非常に大きな数値となって整数オーバーフローになる可能性があるため、注意が必要です。

例:

629644

​
path_collection
パスのコレクション (ごみ箱) · object
必須

ルートフォルダを起点にした、このファイルを含むフォルダツリー。

​
created_at
string<date-time>
必須

Box上でこのファイルが作成された日時。

例:

"2012-12-12T10:53:43-08:00"

​
modified_at
string<date-time>
必須

Boxでこのファイルが最後に更新された日時。

例:

"2012-12-12T10:53:43-08:00"

​
modified_by
ユーザー (Mini) · object
必須

このファイルを最後に変更したユーザー。

​
owned_by
ユーザー (Mini) · object
必須

このファイルを所有するユーザー。

​
item_status
enum<string>
必須

この項目が削除されたかどうかを定義します。

  • active - 項目がごみ箱に移動されていない場合。
  • trashed - 項目がごみ箱に移動されているが、まだ削除されていない場合。
  • deleted - 項目がすでに完全に削除されている場合。
利用可能なオプション:
active,
trashed,
deleted
例:

"trashed"

​
etag
string | null

このファイルのHTTP etag。これは変更が発生した場合 (またはしなかった場合) にファイルに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。

例:

"1"

​
name
string

ファイルの名前。

例:

"Contract.pdf"

​
file_version
ファイルバージョン (Mini) · object

ファイルの現在のバージョンに関する情報。

​
trashed_at
string<date-time> | null

このファイルがごみ箱に移動された日時。

例:

"2012-12-12T10:53:43-08:00"

​
purged_at
string<date-time> | null

このファイルがごみ箱から削除される予定日時。

例:

"2012-12-12T10:53:43-08:00"

​
content_created_at
string<date-time> | null

このファイルが最初に作成された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。

例:

"2012-12-12T10:53:43-08:00"

​
content_modified_at
string<date-time> | null

このファイルが最後に更新された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。

例:

"2012-12-12T10:53:43-08:00"

​
created_by
ユーザー (Mini) · object

このファイルを作成したユーザー。

​
shared_link
string | null

このファイルの共有リンク。ファイルがごみ箱に移動された場合、このリンクはアクティブではなくなるため、これはnullになります。

例:

null

​
parent
フォルダ (Mini) · object

このファイルが配置されているフォルダ。