ファイルバージョンを昇格
特定のファイルバージョンを昇格させます。
以前のバージョンが存在する場合は、この方法を使用して古いバージョンのいずれかをバージョン履歴の先頭に移動できます。
これにより、古いバージョンの新しいコピーが作成されて、バージョン履歴の先頭に配置されます。このファイルは古いバージョンとまったく同じ内容になり、ハッシュダイジェスト、etag、およびファイル名も同じになります。
コメントなど、他のプロパティが以前の値に更新されることはありません。
このエンドポイントは、PDF、DOC、PPTXなどのファイル形式で機能するため、Box Notesの復元には使用しないでください。
リクエスト
bearer [ACCESS_TOKEN]
application/json
パスパラメータ
stringパス内必須
12345ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。
クエリパラメータ
string arrayクエリ内省略可能
id,type,nameレスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
リクエスト本文
string本文内省略可能
"11446498"ファイルバージョンID
string本文内省略可能
"file_version"昇格させるタイプ
次の値に固定: file_version
レスポンス
application/jsonファイルバージョン (Full)
新しく作成されたファイルバージョンオブジェクトを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X POST "https://api.box.com/2.0/files/12345/versions/current" \
-H "authorization: Bearer <ACCESS_TOKEN>" \
-H "content-type: application/json" \
-d '{
"type": "file_version",
"id": "456456"
}'TypeScript Gen
await client.fileVersions.promoteFileVersion(file.id, {
requestBody: {
id: fileVersions.entries![0].id,
type: 'file_version' as PromoteFileVersionRequestBodyTypeField,
} satisfies PromoteFileVersionRequestBody,
} satisfies PromoteFileVersionOptionalsInput);Python Gen
client.file_versions.promote_file_version(
file.id,
id=file_versions.entries[0].id,
type=PromoteFileVersionType.FILE_VERSION.value,
).NET Gen
await client.FileVersions.PromoteFileVersionAsync(fileId: file.Id, requestBody: new PromoteFileVersionRequestBody() { Id = NullableUtils.Unwrap(fileVersions.Entries)[0].Id, Type = PromoteFileVersionRequestBodyTypeField.FileVersion });Java
BoxFile file = new BoxFile(api, "id");
Collection<BoxFileVersion> versions = file.getVersions();
BoxFileVersion firstVersion = versions.iterator().next();
firstVersion.promote();Python
file_id = '11111'
file_version_id = '12345'
version_to_promote = client.file_version(file_version_id)
new_version = client.file(file_id).promote_version(version_to_promote)
print(f'Version {file_version_id} promoted; new version {new_version.id} created').NET
string fileId = "11111";
BoxFileVersion current = await client.FilesManager.PromoteVersionAsync(fileId, versionId: "22222");Node
var fileID = '11111';
var versionID = '22222';
client.files.promoteVersion(fileID, versionID)
.then(version => {
/* version -> {
type: 'file_version',
id: '33333',
sha1: '12039d6dd9a7e6eefc78846802e',
name: 'Stark Family Lineage.pptx',
size: 37934912,
created_at: '2013-11-20T13:20:50-08:00',
modified_at: '2013-11-20T13:26:48-08:00',
modified_by:
{ type: 'user',
id: '44444',
name: 'Eddard Stark',
login: 'ned@winterfell.example.com' } }
*/
});レスポンスの例
{
"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"
}