ファイルを削除

delete
https://api.box.com/2.0
/files/:file_id/

ファイルを削除します(完全に削除するか、ごみ箱に移動します)。

項目がBoxから完全に削除されるか、ごみ箱に移動されるかは、会社の設定により決定されます。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

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

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

リクエストヘッダー

stringヘッダー内
省略可能
1

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

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

レスポンス

none

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

Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。

ファイルが見つからないかすでに削除されている場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。

file_idが認識されていない形式で指定されている場合に返されます。

If-Matchヘッダーがファイルの現在のetag値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。

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

delete
ファイルを削除
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -X DELETE https://api.box.com/2.0/files/12345 \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
.NET
await client.FilesManager.DeleteAsync(id: "11111");
Java
BoxFile file = new BoxFile(api, "id");
file.delete();
Python
client.file(file_id='11111').delete()
Node
client.files.delete('11111', { etag: '5' })
	.then(() => {
		// File successfully deleted
	})
	.catch(err => {
		if (err.statusCode === 412) {
			// Precondition failed — the file was modified before the deletion was processed
			// Read the file again to ensure it is safe to delete and then retry
		}
	});