zipダウンロードのステータスを取得
zipアーカイブのダウンロードステータスを返します。これにより、アプリケーションは、ダウンロードの進行状況のほか、スキップされた可能性のある項目の数を確認できます。
このエンドポイントにアクセスできるのは、ダウンロードが開始された後だけです。このエンドポイントの有効期間は、ダウンロードを開始してから12時間です。
このエンドポイントのURLは固定であるとは考えないでください。代わりに、zipダウンロードを作成APIを使用してzipアーカイブの作成をリクエストした後、このエンドポイントのレスポンスにあるstatus_urlフィールドに従ってください。
リクエスト
bearer [ACCESS_TOKEN]
application/json
パスパラメータ
stringパス内必須
Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mddこのzipアーカイブを表す一意の識別子。
レスポンス
application/jsonzipダウンロードのステータス
ダウンロード中のzipアーカイブのステータスを返します。
application/jsonクライアントエラー
Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。
application/jsonクライアントエラー
承認ヘッダーが指定されていても、ユーザーが項目にアクセスできない場合に返されます。
application/jsonクライアントエラー
このダウンロードリクエストのIDが無効な場合、またはダウンロードが開始される前にダウンロードのステータスがリクエストされた場合にエラーを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X GET "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status" \
-H "authorization: Bearer <ACCESS_TOKEN>"TypeScript Gen
await client.zipDownloads.getZipDownloadStatus(zipDownload.statusUrl!);Python Gen
client.zip_downloads.get_zip_download_status(zip_download.status_url).NET Gen
await client.ZipDownloads.GetZipDownloadStatusAsync(statusUrl: NullableUtils.Unwrap(zipDownload.StatusUrl));レスポンスの例
{
"downloaded_file_count": 10,
"skipped_file_count": 5,
"skipped_folder_count": 5,
"state": "succeeded",
"total_file_count": 20
}