Box Developerドキュメント
最新バージョン

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

get
https://api.box.com/2.0
/files/:file_id/versions/:file_version_id

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

バージョンが追跡されるのは、プレミアムアカウントを持つBoxユーザーのファイルに関してのみです。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

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

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

stringパス内必須
1234

ファイルバージョンのID

クエリパラメータ

string arrayクエリ内省略可能
id,type,name

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

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

レスポンス

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

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

予期しないクライアントエラー。

get
ファイルバージョンを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/versions/456456" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.fileVersions.getFileVersionById(
  file.id,
  fileVersions.entries![0].id,
  {
    queryParams: {
      fields: [
        'trashed_at' as string,
        'trashed_by' as string,
        'restored_at' as string,
        'restored_by' as string,
      ],
    } satisfies GetFileVersionByIdQueryParams,
  } satisfies GetFileVersionByIdOptionalsInput,
);
Python Gen
client.file_versions.get_file_version_by_id(
    file.id,
    file_versions.entries[0].id,
    fields=["trashed_at", "trashed_by", "restored_at", "restored_by"],
)
.NET Gen
await client.FileVersions.GetFileVersionByIdAsync(fileId: file.Id, fileVersionId: NullableUtils.Unwrap(fileVersions.Entries)[0].Id, queryParams: new GetFileVersionByIdQueryParams() { Fields = Array.AsReadOnly(new [] {"trashed_at","trashed_by","restored_at","restored_by"}) });

レスポンスの例

{
  "id": "12345",
  "type": "file_version",
  "created_at": "2012-12-12T10:53:43-08:00",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "tigers.jpeg",
  "purged_at": "2012-12-12T10:53:43-08:00",
  "restored_at": "2012-12-12T10:53:43-08:00",
  "restored_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
  "size": 629644,
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "trashed_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "uploader_display_name": "Ellis Wiggins",
  "version_number": "1"
}