ごみ箱内のフォルダ

ごみ箱内のフォルダを表します。

string

必須

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

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

例:

"123456789"

type

enum<string>

必須

値は常にfolderになります。

利用可能なオプション:

folder

例:

"folder"

name

string

必須

フォルダの名前。

例:

"Contracts"

description

string

必須

このフォルダの説明 (省略可)。

Maximum string length: 256

例:

"Legal contracts for the new ACME deal"

size

integer<int64>

必須

フォルダサイズ (バイト単位)。

この整数を解析する際には、値が非常に大きくなることがあるため注意が必要です。

例:

629644

path_collection

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

必須

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

Show child attributes

created_by

ユーザー (Mini) · object

必須

このフォルダを作成したユーザー。

Show child attributes

modified_by

ユーザー (Mini) · object

必須

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

Show child attributes

owned_by

ユーザー (Mini) · object

必須

このフォルダを所有するユーザー。

Show child attributes

item_status

enum<string>

必須

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

active - 項目がごみ箱に移動されていない場合。
trashed - 項目がごみ箱に移動されているが、まだ削除されていない場合。
deleted - 項目がすでに完全に削除されている場合。

利用可能なオプション:

active,

trashed,

deleted

例:

"trashed"

etag

string | null

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

例:

"1"

sequence_id

string | null

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

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

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

例:

"3"

created_at

string<date-time> | null

このフォルダが作成された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる場合があります。

例:

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

modified_at

string<date-time> | null

このフォルダが最後に更新された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる場合があります。

例:

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

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

このフォルダが最初に作成された日時。

例:

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

content_modified_at

string<date-time> | null

このフォルダが最後に更新された日時。

例:

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

shared_link

string | null

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

例:

null

folder_upload_email

string | null

このフォルダのフォルダアップロード用メールアドレス。フォルダがごみ箱に移動された場合、アップロードは動作しなくなるため、これはnullになります。

例:

null

parent

フォルダ (Mini) · object

このフォルダが配置されているフォルダ (省略可)

ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになることがあります。

Show child attributes

Documentation Index