フォルダを復元 - Box Dev Docs

このリソースは、バージョン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版の表示のフィールドしか返されないことに注意してください。

Body

application/json

name

string

フォルダの新しい名前 (省略可)。

Example:

"Restored Photos"

parent

object

元のフォルダがすでに存在しない場合にフォルダの復元先となるフォルダのID (省略可) を指定します。

このIDは、元のフォルダがすでに存在しない場合にのみ使用されることに注意してください。このIDは、元の場所が削除されている場合にフォルダの復元先となるフォールバックの場所を指定します。

表示子属性

Response

フォルダが復元されたときにフォルダオブジェクトを返します。

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

string

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

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

Example:

"123456789"

etag

string | null

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

Example:

"1"

type

enum<string>

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

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"

name

string

フォルダの名前。

Example:

"Contracts"

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"

description

string

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

Maximum string length: 256

Example:

"Legal contracts for the new ACME deal"

size

integer<int64>

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

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

Example:

629644

path_collection

パスのコレクション · object

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

表示子属性

created_by

ユーザー (Mini) · object

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

表示子属性

modified_by

ユーザー (Mini) · object

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

表示子属性

trashed_at

string | null

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

Example:

null

purged_at

string | null

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

Example:

null

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"

owned_by

ユーザー (Mini) · object

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

表示子属性

shared_link

string | null

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

Example:

null

folder_upload_email

string | null

このフォルダのフォルダアップロード用メールアドレス。フォルダがごみ箱に移動された場合、元のアップロード用メールアドレスが再度アクティブになっても、これはnullになります。

Example:

null

parent

フォルダ (Mini) · object

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

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

表示子属性

item_status

enum<string>

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

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

利用可能なオプション:

active,

trashed,

deleted

Example:

"active"