ファイルバージョンを削除

delete

https://api.box.com/2.0

/files/:file_id/versions/:file_version_id

特定のファイルバージョンをごみ箱に移動します。

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

リクエスト

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

パスパラメータ

file_id stringパス内必須

例12345

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

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

file_version_id stringパス内必須

例1234

ファイルバージョンのID

リクエストヘッダー

if-match stringヘッダー内省略可能

例1

変更を加える前にこの項目が最近変更されていないことを確認します。

その項目の最後に認識されたetag値をこのヘッダーに渡すと、それ以降に項目が変更されている場合、エンドポイントは412 Precondition Failedを返して失敗します。

レスポンス

204none

ファイルが正常に削除された場合は、空のレスポンスを返します。

defaultapplication/jsonクライアントエラー

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

delete

ファイルバージョンを削除

このドキュメント内で一部のAPIを試せるようになりました。

ログイン

リクエストの例

cURL

curl -i -X DELETE "https://api.box.com/2.0/files/12345/versions/456456" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

TypeScript Gen

await client.fileVersions.deleteFileVersionById(file.id, fileVersion.id);

Python Gen

client.file_versions.delete_file_version_by_id(file.id, file_version.id)

.NET Gen

await client.FileVersions.DeleteFileVersionByIdAsync(fileId: file.Id, fileVersionId: fileVersion.Id);

Java

BoxFile file = new BoxFile(api, "id");
Collection<BoxFileVersion> versions = file.getVersions();
BoxFileVersion firstVersion = versions.iterator().next();
firstVersion.delete();

Python

file_id = '11111'
version_id = '12345'

version_to_delete = client.file_version(version_id)
client.file(file_id).delete_version(version_to_delete)

.NET

string fileId = "11111";
await client.FilesManager.DeleteOldVersionAsync(fileId, versionId: "22222");

Node

var fileID = '11111';
var versionID = '22222';
client.files.deleteVersion(fileID, versionID)
	.then(() => {
		// deletion succeeded — no value returned
	});