圧縮ダウンロードのステータスを取得

get
https://api.box.com/2.0
/zip_downloads/:zip_download_id/status/

zipアーカイブのダウンロードステータスを返します。これにより、アプリケーションは、ダウンロードの進行状況のほか、スキップされた可能性のある項目の数を確認できます。

このエンドポイントにアクセスできるのは、ダウンロードが開始された後だけです。このエンドポイントの有効期間は、ダウンロードを開始してから12時間です。

このエンドポイントのURLは固定であるとは考えないでください。代わりに、圧縮ダウンロードを作成 APIを使用してzipアーカイブの作成をリクエストした後、このエンドポイントの応答にあるstatus_urlフィールドに従ってください。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd

このzipアーカイブを表す一意の識別子。

レスポンス

ダウンロード中のzipアーカイブのステータスを返します。

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

承認ヘッダーが指定されていても、ユーザーが項目にアクセスできない場合に返されます。

このダウンロードリクエストのIDが無効な場合、またはダウンロードが開始される前にダウンロードのステータスがリクエストされた場合にエラーを返します。

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

get
圧縮ダウンロードのステータスを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"

レスポンスの例

{
  "downloaded_file_count": 10,
  "skipped_file_count": 5,
  "skipped_folder_count": 5,
  "state": "success",
  "total_file_count": 20
}