ファイルをダウンロード
get
https://api.box.com/2.0
/files/:file_id/content
ファイルのコンテンツをバイナリ形式で返します。
リクエスト
application/json
パスパラメータ
stringパス内必須
12345ファイルを表す一意の識別子。
ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。
クエリパラメータ
stringクエリ内省略可能
4ダウンロードするファイルバージョン
リクエストヘッダー
stringヘッダー内省略可能
shared_link=[link]共有リンクを使用して共有されているファイルのURLとパスワード。ユーザーが他の方法でこのファイルにアクセスすることはできません。
shared_link=SHARED_LINK_URLの形式、またはshared_link=[link]&shared_link_password=[password]の形式(パスワードが設定されている場合)を使用します。
stringヘッダー内省略可能
0-1024ダウンロードするコンテンツのバイト範囲。
{start_byte}-{end_byte}の形式を使用して、ダウンロードするファイルのセクションを指定できます。
レスポンス
none
ファイルをダウンロードする準備ができていない場合は、クライアントがファイルをダウンロードできるようになるまでの秒数を示すRetry-Afterヘッダーが返されます。
この応答は、ダウンロードリクエストの直前にファイルがアップロードされた場合に発生することがあります。
none
ファイルがダウンロード可能な場合、応答にはdl.boxcloud.com上のファイルのLocationヘッダーが含まれます。
dl.boxcloud.comというURLは永続的なものではないため、クライアントで実際にファイルをダウンロードするには、リダイレクト指示に従う必要があります。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -X GET https://api.box.com/2.0/files/12345/content \
-H 'Authorization: Bearer <ACCESS_TOKEN>" '
-L.NET
Stream fileContents = await client.FilesManager.DownloadStreamAsync(id: "11111");Java
BoxFile file = new BoxFile(api, "id");
BoxFile.Info info = file.getInfo();
FileOutputStream stream = new FileOutputStream(info.getName());
file.download(stream);
stream.close();Python
file_id = '11111'
file_content = client.file(file_id).content()Node
var fs = require('fs');
client.files.getReadStream('12345', null, function(error, stream) {
if (error) {
// handle error
}
// write the file to disk
var output = fs.createWriteStream('/path/to/file');
stream.pipe(output);
});iOS
let url = FileManager.default.homeDirectoryForCurrentUser
let task: BoxDownloadTask = client.files.download(fileId: "11111", destinationURL: url) { (result: Result<Void, BoxSDKError>) in
guard case .success = result else {
print("Error downloading file")
return
}
print("File downloaded successfully")
}
// To cancel download
if someConditionIsSatisfied {
task.cancel()
}