Folder (Mini)

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

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

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

string
12345

フォルダを表す一意の識別子。

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

string
folder

次の値に固定: folder

string
1

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

string
Contracts

フォルダの名前。

3

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

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

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

レスポンスの例

{
  "id": 12345,
  "type": "folder",
  "etag": 1,
  "name": "Contracts",
  "sequence_id": 3
}