メインコンテンツへスキップ

ごみ箱から復元されたファイルを表します。

id
string
必須

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

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

:

"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
:

"active"

etag
string | null

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

:

"1"

name
string

ファイルの名前。

:

"Contract.pdf"

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

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

trashed_at
string | null

このファイルがごみ箱に移動された日時。復元後はnullになります。

:

null

purged_at
string | null

このファイルがごみ箱から削除される予定日時。復元後はnullになります。

:

null

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

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

このファイルの共有リンク。ファイルがごみ箱に移動された場合、元の共有リンクが再度アクティブになっても、これはnullになります。

:

null

parent
フォルダ (Mini) · object

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