エンドポイント

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

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

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

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

GET

zip_downloads

{zip_download_id}

status

cURL

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

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

このリソースは、バージョン2024.0のエンドポイントで使用されています。詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

承認

Authorization

string

header

必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

zip_download_id

string

必須

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

レスポンス

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

ダウンロード中のzipアーカイブのステータス。

total_file_count

integer

このアーカイブ内のファイルの合計数。

必須範囲: 0 <= x <= 10000

例:

20

downloaded_file_count

integer

すでにダウンロードされているファイルの数。

必須範囲: x >= 0

例:

10

skipped_file_count

integer

ダウンロードできなかったためスキップされたファイルの数。多くの場合、この原因は、アーカイブに対するリクエストの作成と、ダウンロードされるアーカイブとの間に発生した権限に関する問題です。

必須範囲: x >= 0

例:

5

skipped_folder_count

integer

ダウンロードできなかったためスキップされたフォルダの数。多くの場合、この原因は、アーカイブに対するリクエストの作成と、ダウンロードされるアーカイブとの間に発生した権限に関する問題です。

必須範囲: x >= 0

例:

5

state

enum<string>

デフォルト:in_progress

ダウンロード中のアーカイブの状態。

利用可能なオプション:

in_progress,

failed,

succeeded

例:

"succeeded"

zipアーカイブをダウンロード

zipダウンロードを作成

⌘I

Documentation Index

承認

パスパラメータ

レスポンス