このリソースにはAPIの使用時に発生する可能性があるいくつかのバリエーションがあります。Fullバリアントに含まれるフィールドは、
fieldsパラメータをサポートするAPIエンドポイントによって返すことができます。たとえば、IDでファイルを取得するときに、fieldsリクエストパラメータをid,typeに設定すると、これらのフィールドのみがAPIレスポンスで返されます。例
12345ファイルを表す一意の識別子。ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。例
file値は常にfileになります。次の値に固定: file例
["editor"]このファイルを共有するときに招待できるユーザーの役割タイプのリスト。このファイルに適用された分類に関する詳細
例
10このファイルに関するコメントの数。例
2012-12-12T10:53:43-08:00このファイルが最初に作成された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。例
2012-12-12T10:53:43-08:00このファイルが最後に更新された日時。この日時はファイルがBoxにアップロードされた時点よりも前になる場合があります。例
2012-12-12T10:53:43-08:00Box上でこのファイルが作成された日時。このファイルを作成したユーザー。
例
Contract for Q1 renewalこのファイルの説明 (省略可)。説明が255文字を超える場合は、最初の255文字がファイルの説明として設定され、残りは無視されます。例
2012-12-12T10:53:43-08:00特定のファイルのリテンションの有効期限のタイムスタンプ。例
1このファイルのHTTP etag。これは変更が発生した場合 (またはしなかった場合) にファイルに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。例
2012-12-12T10:53:43-08:00ファイルが自動的に削除される日時。このフィールドをリクエストすると、
iframeに埋め込まれたプレビューセッション用の有効期限付きBox Embed URLが作成されます。このURLは60秒後に有効期限切れとなり、セッションはその60分後に有効期限切れとなります。一部のファイルタイプは、これらの埋め込みURLでサポートされていません。Box Embedはモバイルブラウザ向けに最適化されていないため、モバイルデバイス用に設計されたウェブエクスペリエンスでは使用しないでください。多くのUI Element (ダウンロードオプションや印刷オプションなど) はモバイルブラウザに表示されない可能性があります。例
pdfこのファイルのファイル拡張子 (省略可) を示します。デフォルトでは、空の文字列に設定されます。ファイルの現在のバージョンに関する情報。
例
trueこのファイルに他のコラボレータが存在するかどうかを指定します。例
true直接共有リンクまたは親フォルダへの共有リンクを使用してファイルにアクセスできるかどうかを指定します。例
trueファイルまたはファイルの先祖が1つ以上のアプリ項目に関連付けられている場合、このフィールドはtrueを返します。コンテキストユーザーがそのファイルに関連付けられたアプリ項目にアクセスできない場合でもtrueが返されることに注意してください。例
trueこのファイルが認証済みの会社以外のユーザーによって所有されているかどうかを指定します。例
trueファイルがパッケージかどうかを示します。パッケージはMacアプリケーションで一般的に使用され、iWorkファイルを含めることができます。例
activeこの項目が削除されたかどうかを定義します。active- 項目がごみ箱に移動されていない場合。trashed- 項目がごみ箱に移動されているが、まだ削除されていない場合。deleted- 項目がすでに完全に削除されている場合。
active,trashed,deletedこのファイルで保持されているロック。ロックが存在しない場合は
nullになるか、過去のタイムスタンプになります。このファイルに追加されたメタデータインスタンスを含むオブジェクト。各メタデータインスタンスは、その
scopeとtemplateKeyによって一意に識別されます。各ファイルに追加されるメタデータテンプレートのインスタンスは1つだけです。各メタデータインスタンスは、キーとしてtemplateKeyが指定されているオブジェクト内にネストされ、さらにそのオブジェクト自体もキーとしてscopeが指定されているオブジェクト内にネストされます。例
2012-12-12T10:53:43-08:00Boxでこのファイルが最後に更新された日時。このファイルを最後に変更したユーザー。
例
Contract.pdfファイルの名前。このファイルを所有するユーザー。
このフォルダが配置されているフォルダ。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値は
nullになる可能性があります。ルートフォルダを起点にした、このファイルを含むフォルダツリー。
このファイルに対して現在のユーザーが持っている権限について説明します。
例
2012-12-12T10:53:43-08:00このファイルがごみ箱から削除される予定日時。アプリケーション内でファイルのプレースホルダを表示するために使用できるレプリゼンテーションのリスト。デフォルトでは、すべてのレプリゼンテーションが返されるため、
x-rep-hintsヘッダーを使用して目的のレプリゼンテーションをさらにカスタマイズすることをお勧めします。例
3この項目に適用された最新のUser Eventを表す数値の識別子。これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。例
85136C79CBF9FE36BB9D05D0639C70C265C18D37ファイルのSHA1ハッシュ。Box上のファイルとローカルファイルの内容を比較する目的に使用できます。このファイルの共有リンク。このファイルに対してまだ共有リンクが作成されていない場合、この値は
nullになります。例
["can_preview"]このファイルを共有するときに招待できるユーザーの役割タイプのリスト。例
629644ファイルサイズ (バイト単位)。この整数を解析する際には、非常に大きな数値となって整数オーバーフローになる可能性があるため、注意が必要です。例
["approved"]この項目のタグ。これらのタグはBoxウェブアプリおよびモバイルアプリで項目の横に表示されます。タグを追加または削除するには、項目の現在のタグを取得して変更してから、このフィールドを更新します。タグの数は、1項目あたり100個までに制限され、一意のタグは会社あたり10,000個までに制限されます。例
2012-12-12T10:53:43-08:00このファイルがごみ箱に移動された日時。例
Ellis Wigginsファイルをアップロードしたユーザーの表示名。ほとんどの場合、これはアップロード時点でログインしているユーザーの名前です。このファイルのアップロードに、ユーザーに対してメールアドレスの入力を要求するファイルリクエストフォームが使用された場合、このフィールドにはそのメールアドレスが設定されます。メールアドレスがファイルリクエストフォームで要求されなかった場合、このフィールドは、File Requestという値を返すように設定されます。メールアドレスが指定されなかったその他すべての匿名のケースでは、このフィールドの値がデフォルトでSomeoneになります。例
1このファイルのバージョン番号。このファイルに適用された電子すかしに関する詳細。