ファイルバージョンを取得

承認

Authorization

string

header

必須

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

パスパラメータ

file_id

string

必須

ファイルを表す一意の識別子。

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

file_version_id

string

必須

ファイルバージョンのID。

クエリパラメータ

fields

string[]

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

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

レスポンス

特定のファイルバージョンを返します。

使用可能なすべてのフィールドがデフォルトで返されるとは限りません。特定のフィールドを明示的にリクエストするには、fieldsクエリパラメータを使用します。

任意のファイルバージョンAPIエンドポイントからデフォルトで返される可能性がある、ファイルバージョンのFull版の表示。

string

必須

ファイルバージョンを表す一意の識別子。

例:

"12345"

type

enum<string>

必須

値は常にfile_versionになります。

利用可能なオプション:

file_version

例:

"file_version"

sha1

string

ファイルの現在のバージョンのSHA1ハッシュ。

例:

"134b65991ed521fcfe4724b7d814ab8ded5185dc"

name

string

ファイルバージョンの名前。

例:

"tigers.jpeg"

size

integer<int64>

ファイルバージョンのサイズ (バイト単位)。

例:

629644

created_at

string<date-time>

ファイルバージョンオブジェクトが作成された日時。

例:

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

modified_at

string<date-time>

ファイルバージョンオブジェクトが最後に更新された日時。

例:

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

modified_by

ユーザー (Mini) · object

ファイルバージョンを最後に更新したユーザー。

Show child attributes

trashed_at

string<date-time> | null

ファイルバージョンオブジェクトがごみ箱に移動された日時。

例:

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

trashed_by

ユーザー (Mini) · object

ファイルバージョンをごみ箱に移動したユーザー。

Show child attributes

restored_at

string<date-time> | null

ファイルバージョンがごみ箱から復元された日時。

例:

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

restored_by

ユーザー (Mini) · object

ごみ箱からファイルバージョンを復元したユーザー。

Show child attributes

purged_at

string<date-time> | null

ファイルバージョンオブジェクトが完全に削除される日時。

例:

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

uploader_display_name

string

ファイルをアップロードしたユーザーの表示名。ほとんどの場合、これはアップロード時点でログインしているユーザーの名前です。

このファイルのアップロードに、ユーザーに対してメールアドレスの入力を要求するファイルリクエストフォームが使用された場合、このフィールドにはそのメールアドレスが設定されます。メールアドレスがファイルリクエストフォームで要求されなかった場合、このフィールドは、File Requestという値を返すように設定されます。

メールアドレスが指定されなかったその他すべての匿名のケースでは、このフィールドの値がデフォルトでSomeoneになります。

例:

"Ellis Wiggins"

version_number

string

このファイルバージョンのバージョン番号。

例:

"1"