File (Mini)

他のリソースの下にネストされたときに使用される、ファイルの簡易版レプリゼンテーション。

このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。

通常、簡易バリアントに含まれるフィールドは、このリソースが別のリソースの応答内にネストされている場合に返されます。

string
12345

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

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

string
file

次の値に固定: file

string
1

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

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

string
Contract.pdf

ファイルの名前

3

この項目に適用された最新のユーザーイベントを表す数値の識別子。

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

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

string / digest
85136C79CBF9FE36BB9D05D0639C70C265C18D37

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

レスポンスの例

{
  "id": 12345,
  "type": "file",
  "etag": 1,
  "file_version": {
    "id": 12345,
    "type": "file_version",
    "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
  },
  "name": "Contract.pdf",
  "sequence_id": 3,
  "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37"
}