ごみ箱内のフォルダを取得

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

Authorizations

Authorization

string

header

required

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

Path Parameters

folder_id

string

required

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

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

Boxアカウントのルートフォルダは常にID 0で表されます。

Query Parameters

fields

string[]

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

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

Response

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

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

string

required

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

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

Example:

"123456789"

type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

name

string

required

フォルダの名前。

Example:

"Contracts"

description

string

required

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

Maximum string length: 256

Example:

"Legal contracts for the new ACME deal"

size

integer<int64>

required

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

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

Example:

629644

path_collection

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

required

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

表示子属性

path_collection.total_count

integer<int64>

required

このリスト内のフォルダの数。

Example:

1

path_collection.entries

object[]

required

この項目のパスのコレクションのフォルダの配列。

表示子属性

path_collection.entries.type

enum<string>

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

path_collection.entries.id

string

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

Example:

"123456789"

path_collection.entries.sequence_id

string | null

ごみ箱フォルダの場合、このフィールドはnullです。

Example:

null

path_collection.entries.etag

string | null

ごみ箱フォルダの場合、このフィールドはnullです。

Example:

null

path_collection.entries.name

string

ごみ箱フォルダの名前。

Example:

"Trash"

created_by

ユーザー (Mini) · object

required

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

表示子属性

created_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

created_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

created_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

modified_by

ユーザー (Mini) · object

required

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

表示子属性

modified_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

modified_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

modified_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

owned_by

ユーザー (Mini) · object

required

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

表示子属性

owned_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

owned_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

owned_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

item_status

enum<string>

required

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

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

利用可能なオプション:

active,

trashed,

deleted

Example:

"trashed"

etag

string | null

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

Example:

"1"

sequence_id

string | null

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

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

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

Example:

"3"

created_at

string<date-time> | null

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

Example:

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

modified_at

string<date-time> | null

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

Example:

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

trashed_at

string<date-time> | null

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

Example:

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

purged_at

string<date-time> | null

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

Example:

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

content_created_at

string<date-time> | null

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

Example:

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

content_modified_at

string<date-time> | null

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

Example:

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

shared_link

string | null

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

Example:

null

folder_upload_email

string | null

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

Example:

null

parent

フォルダ (Mini) · object

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

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

表示子属性

parent.id

string

required

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

Example:

"12345"

parent.type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

parent.etag

string | null

Example:

"1"

parent.sequence_id

string | null

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

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

Example:

"3"

parent.name

string

フォルダの名前。

Example:

"Contracts"