フォルダを削除
フォルダを完全に削除するか、ごみ箱に移動して削除します。
リクエスト
リクエストヘッダー
1変更を加える前にこの項目が最近変更されていないことを確認します。
その項目の最後に認識されたetag値をこのヘッダーに渡すと、それ以降に項目が変更されている場合、エンドポイントは412 Precondition Failedを返して失敗します。
パスパラメータ
12345フォルダを表す一意の識別子。
フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_idは123です。
Boxアカウントのルートフォルダは常にID 0で表されます。
クエリパラメータ
trueフォルダとその中にあるすべてのコンテンツを再帰的に削除することにより、空でないフォルダを削除します。
レスポンス
フォルダが正常に削除された場合、またはごみ箱に移動された場合は、空のレスポンスを返します。
ユーザーが不適切なリクエストを行った場合にエラーを返します。
folder_not_empty: フォルダが空でない場合に返されます。フォルダとそのコンテンツを再帰的に削除するには、recursiveクエリパラメータを使用します。
ユーザーにこのアクションを実行するためのアクセス権限がない場合はエラーを返します。
-
access_denied_insufficient_permissions: ユーザーにフォルダへのアクセス権限がない場合、または削除されないようにフォルダにフォルダロックが適用されている場合に返されます。 -
insufficient_scope: アプリケーションにフォルダを削除するための適切なスコープがない場合にエラーが返されます。Boxに格納されているすべてのファイルとフォルダに対して読み取りと書き込みを行えるようにアプリケーションが設定されていることを確認してください。
フォルダが見つからないか、認証済みユーザーが親フォルダにアクセスできない場合は、エラーを返します。
not_found- 認証済みユーザーがフォルダにアクセスできない場合に返されます。
-
operation_blocked_temporary: 別の移動、コピー、削除、または復元操作が進行中であることによりフォルダがロックされている場合に返されます。操作は後で再試行することができます。
If-Matchヘッダーがフォルダの現在のetag値と一致しない場合はエラーを返します。これは、フォルダが前回リクエストされたときから変更され ていることを示します。
操作の処理時間が60秒を超えるとエラーを返します。このレスポンスが返された後も操作は続行されます。
予期しないクライアントエラー。
リクエストの例
curl -i -X DELETE "https://api.box.com/2.0/folders/4353455" \
-H "authorization: Bearer <ACCESS_TOKEN>"await parentClient.folders.deleteFolderById(folder.id);parent_client.folders.delete_folder_by_id(folder.id)await parentClient.Folders.DeleteFolderByIdAsync(folderId: folder.Id);// Delete the folder and all its contents
BoxFolder folder = new BoxFolder(api, "id");
folder.delete(true);client.folder(folder_id='22222').delete()await client.FoldersManager.DeleteAsync("11111", recursive: true);client.folders.delete('12345', {recursive: true})
.then(() => {
// deletion succeeded — no value returned
});client.folders.delete(folderId: "22222", recursive: true) { result: Result<Void, BoxSDKError>} in
guard case .success = result else {
print("Error deleting folder")
return
}
print("Folder and contents successfully deleted")
}