ファイルリクエストを削除

delete

https://api.box.com/2.0

/file_requests/:file_request_id

ファイルリクエストを完全に削除します。

関連するガイド

リクエスト

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

パスパラメータ

file_request_id stringパス内必須

例123

ファイルリクエストを表す一意の識別子。

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

レスポンス

204none

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

401application/jsonクライアントエラー

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

404application/jsonクライアントエラー

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

405application/jsonクライアントエラー

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

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

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

delete

ファイルリクエストを削除

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

ログイン

リクエストの例

cURL

curl -i -X DELETE "https://api.box.com/2.0/file_requests/42037322" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

TypeScript Gen

await client.fileRequests.deleteFileRequestById(updatedFileRequest.id);

Python Gen

client.file_requests.delete_file_request_by_id(updated_file_request.id)

.NET Gen

await client.FileRequests.DeleteFileRequestByIdAsync(fileRequestId: updatedFileRequest.Id);

Java

BoxFileRequest fileRequest = new BoxFileRequest(api, "id");
fileRequest.delete();

Python

file_request = client.file_request(file_request_id='123456')
file_request.delete()

.NET

bool isSuccess = await client.FileRequestsManager.DeleteFileRequestAsync("12345");

Node

client.fileRequests.delete('2484517969').then(() => console.log('Removed file request'));

iOS

client.fileRequests.delete(fileRequestId: "123456") { result in
    guard case .success = result else {
        print("Error removing file request")
        return
    }

    print("File request removed")
}