Box Developerドキュメント

すべてのファイルバージョンのリストを取得

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

ファイルの過去のバージョンのリストを取得します。

バージョンを追跡するのは、プレミアム (有償) アカウントを持つBoxユーザーのみです。ファイルの現在のバージョンのIDを取得するには、GET /file/:id APIを使用します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

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

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

クエリパラメータ

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

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

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

integer (int64)クエリ内省略可能
1000
1000

返す項目の1ページあたりの最大数。

integer (int64)クエリ内省略可能
1000
0

レスポンスが開始される項目のオフセット。

オフセットパラメータ値が10,000を超えているクエリは拒否され、400レスポンスが返されます。

レスポンス

このファイルの過去のバージョンの配列を返します。

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

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

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/files/12345/versions" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.fileVersions.getFileVersions(file.id);
Python Gen
client.file_versions.get_file_versions(file.id)
.NET Gen
await client.FileVersions.GetFileVersionsAsync(fileId: file.Id);
Java
BoxFile file = new BoxFile(api, "id");
Collection<BoxFileVersion> versions = file.getVersions();
for (BoxFileVersion version : versions) {
    System.out.format("SHA1 of \"%s\": %s\n", file.getInfo().getName(), version.getSha1());
}
Python
file_id = '11111'

file_versions = client.file(file_id).get_previous_versions()
for version in file_versions:
    print(f'File version {version.id} was created at {version.created_at}')
.NET
BoxCollection<BoxFileVersion> previousVersions = await client.FilesManager
    .ViewVersionsAsync(id: "11111");
Node
client.files.getVersions('12345')
	.then(versions => {
		/* versions -> {
			total_count: 1,
			entries: 
			[ { type: 'file_version',
				id: '22222',
				sha1: '359c6c1ed98081b9a69eb3513b9deced59c957f9',
				name: 'script.js',
				size: 92556,
				created_at: '2012-08-20T10:20:30-07:00',
				modified_at: '2012-11-28T13:14:58-08:00',
				modified_by: 
					{ type: 'user',
					id: '33333',
					name: 'Example User',
					login: 'user@example.com' } } ] }
		*/
	});

レスポンスの例

{
  "entries": [
    {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
      "name": "tigers.jpeg",
      "size": 629644,
      "created_at": "2012-12-12T10:53:43-08:00",
      "modified_at": "2012-12-12T10:53:43-08:00",
      "modified_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "trashed_at": "2012-12-12T10:53:43-08:00",
      "trashed_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "restored_at": "2012-12-12T10:53:43-08:00",
      "restored_by": {
        "id": "11446498",
        "type": "user",
        "name": "Aaron Levie",
        "login": "ceo@example.com"
      },
      "purged_at": "2012-12-12T10:53:43-08:00",
      "uploader_display_name": "Ellis Wiggins",
      "version_number": "1"
    }
  ],
  "limit": 1000,
  "offset": 2000,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    }
  ],
  "total_count": 5000
}