このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。Fullバリアントに含まれるフィールドは、
fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPIレスポンスで返されます。例
12345フォルダを表す一意の識別子。フォルダIDを確認するには、ウェブアプリケーションでフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folders/123の場合、folder_idは123です。例
folder値は常にfolderになります。次の値に固定: folder例
["editor"]このフォルダを共有するときに招待できるユーザーの役割タイプのリスト。例
["open"]このフォルダで使用できるアクセスレベルのリスト。ルートフォルダなどの一部のフォルダでは共有が許可されていないため、このリストは常に空になります。例
trueフォルダの所有者ではないユーザーがそのフォルダに新しいコラボレータを招待できるかどうかを指定します。例
trueこのフォルダの所有者ではないコラボレータがこのフォルダの他のコラボレータを表示できないように制限するかどうかを指定します。この制限を有効にした場合は、所有者ではないユーザーが新しいコラボレータを招待することも制限されます。このフォルダに適用された分類に関する詳細。
例
2012-12-12T10:53:43-08:00このフォルダが最初に作成された日時。例
2012-12-12T10:53:43-08:00このフォルダが最後に更新された日時。例
2012-12-12T10:53:43-08:00このフォルダが作成された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる場合があります。このフォルダを作成したユーザー。
例
Legal contracts for the new ACME dealこのフォルダの説明 (省略可)。例
1このフォルダのHTTP etag。これは変更が発生した場合 (またはしなかった場合) にフォルダに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。以下のオプションのいずれかがtrueの場合、
folder_upload_emailパラメータはnullではありません。- [このフォルダへのメールによるアップロードを許可する] および [このフォルダのコラボレータにのみメールによるアップロードを許可する] が管理コンソールで1フォルダに対して有効になっていて、ユーザーには少なくともアップロード権限が付与されています。
- [このフォルダへのメールによるアップロードを許可する] の設定が管理コンソールで1フォルダに対して有効になっていて、[このフォルダのコラボレータにのみメールによるアップロードを許可する] の設定が無効 (オフ) になっています。
folder_upload_email: null。例
trueこのフォルダに他のコラボレータが存在するかどうかを指定します。例
true直接共有リンクまたは親フォルダへの共有リンクを使用してフォルダにアクセスできるかどうかを指定します。例
trueフォルダまたはフォルダの先祖が1つ以上のアプリ項目に関連付けられている場合、このフィールドはtrueを返します。コンテキストユーザーがそのフォルダに関連付けられたアプリ項目にアクセスできない場合でもtrueが返されることに注意してください。例
trueこのフォルダへの招待を社内のユーザーのみに限定するかどうかを指定します。既存のコラボレーションには影響しません。例
trueこのフォルダが認証済みの会社以外のユーザーによって所有されているかどうかを指定します。フォルダ内の項目のページ。このフィールドをリクエストできるのは、フォルダの情報をクエリで照会するときのみで、フォルダの項目をクエリで照会するときにはリクエストできません。
例
activeこの項目が削除されたかどうかを定義します。active- 項目がごみ箱に移動されていない場合。trashed- 項目がごみ箱に移動されているが、まだ削除されていない場合。deleted- 項目がすでに完全に削除されている場合。
active,trashed,deletedこのフォルダに追加されたメタデータインスタンスを含むオブジェクト。各メタデータインスタンスは、その
scopeとtemplateKeyによって一意に識別されます。各フォルダに追加されるメタデータテンプレートのインスタンスは1つだけです。各メタデータインスタンスは、キーとしてtemplateKeyが指定されているオブジェクト内にネストされ、さらにそのオブジェクト自体もキーとしてscopeが指定されているオブジェクト内にネストされます。例
2012-12-12T10:53:43-08:00このフォルダが最後に更新された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる場合があります。このフォルダを最後に変更したユーザー。
例
Contractsフォルダの名前。このフォルダを所有するユーザー。
このフォルダが配置されているフォルダ (省略可)ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は
nullになることがあります。ルートフォルダを起点にした、このフォルダを含むフォルダツリー。
このフォルダに対して現在のユーザーが持っている権限について説明します。
例
2012-12-12T10:53:43-08:00このフォルダがごみ箱から削除される予定日時。例
3この項目に適用された最新のUser Eventを表す数値の識別子。これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。このフォルダの共有リンク。このフォルダに対してまだ共有リンクが作成されていない場合は、
nullになります。例
629644フォルダサイズ (バイト単位)。この整数を解析する際には、値が非常に大きくなることがあるため注意が必要です。例
syncedフォルダをユーザーのデバイスに同期する必要があるかどうかを指定します。これはBox Sync (廃止済み) で使用され、Box Driveでは 使用されません。次の値のいずれか1つ: synced,not_synced,partially_synced例
["approved"]この項目のタグ。これらのタグはBoxウェブアプリおよびモバイルアプリで項目の横に表示されます。タグを追加または削除するには、項目の現在のタグを取得して変更してから、このフィールドを更新します。タグの数は、1項目あたり100個までに制限され、一意のタグは会社あたり10,000個までに制限されます。例
2012-12-12T10:53:43-08:00このフォルダがごみ箱に移動された日時。このフォルダに適用された電子すかしに関する詳細。