zipダウンロード
ファイルやフォルダのリストのzipアーカイブを作成するリクエストが成功したことを表します。
属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
download_url | string | いいえ | zipアーカイブのダウンロードに使用できるURL。このURLに対するGetリクエストにより、リクエストされた項目のストリーミングが開始されます。デフォルトでは、このURLは、ダウンロードが開始されない限り、expires_atの時間までの数秒間だけ有効です。ダウンロードが開始されると、ダウンロードしている間は有効です。 このURLのドメインとパスは、APIコール間で変更される可能性があるため、このURLをそのまま使用することが重要です。 |
status_url | string | いいえ | ダウンロード中のzipアーカイブのステータスを取得するために使用できるURL。このURLに対するGetリクエストにより、アーカイブ内のファイル数に加え、すでにダウンロードまたはスキップされた項目の数が返されます。デフォルトでは、このURLは、ダウンロードが開始されない限り、expires_atの時間までの数秒間だけ有効です。ダウンロードの開始後、このURLは12時間有効です。 このURLのドメインとパスは、APIコール間で変更される可能性があるため、このURLをそのまま使用することが重要です。 |
expires_at | string | いいえ | このアーカイブの有効期限が切れる日時。この日時を経過すると、status_urlとdownload_urlによってエラーが返されます。 デフォルトでは、このURLは、ダウンロードが開始されない限り、download_urlの時間までの数秒間だけ有効です。ダウンロードが開始されると、ダウンロードしている間は有効です。また、status_urlの有効期間は、ダウンロードを開始してから12時間です。 |
name_conflicts | array of array of object | いいえ | アーカイブを作成しようとしたときに発生した競合のリスト。これは、複数の項目が同じ名前でリクエストされたときに発生します。 これらの競合を解決するために、APIでは、自動的に項目の名前を変更し、項目の元の名前と新しい名前の間のマッピングを返します。 競合ごとに、両方のファイル名が変更されるため、このリストは常に2の倍数になります。 |
例
{
"download_url": "https://dl.boxcloud.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/content",
"status_url": "https://api.box.com/2.0/zip_downloads/29l00nfxDyHOt7RphI9zT_w==nDnZEDjY2S8iEWWCHEEiptFxwoWojjlibZjJ6geuE5xnXENDTPxzgbks_yY=/status",
"expires_at": "2020-07-22T11:26:08Z",
"name_conflicts": [
[
{
"id": "12345",
"type": "file",
"original_name": "Report.pdf",
"download_name": "3aa6a7.pdf"
},
{
"id": "34325",
"type": "file",
"original_name": "Report.pdf",
"download_name": "5d53f2.pdf"
}
]
]
}
zipダウンロードのステータス
ダウンロード中のzipアーカイブのステータス。
属性と例
属性と例
| プロパティ | 型 | 必須 | 説明 |
|---|---|---|---|
total_file_count | integer | いいえ | このアーカイブ内のファイルの合計数。 |
downloaded_file_count | integer | いいえ | すでにダウンロードされているファイルの数。 |
skipped_file_count | integer | いいえ | ダウンロードできなかったためスキップされたファイルの数。多くの場合、この原因は、アーカイブに対するリクエストの作成と、ダウンロードされるアーカイブとの間に発生した権限に関する問題です。 |
skipped_folder_count | integer | いいえ | ダウンロードできなかったためスキップされたフォルダの数。多くの場合、この原因は、アーカイブに対するリクエストの作成と、ダウンロードされるアーカイブとの間に発生した権限に関する問題です。 |
state | enum<string> | いいえ | ダウンロード中のアーカイブの状態。 使用可能なオプション: in_progress, failed, succeeded. |
例
{
"total_file_count": 20,
"downloaded_file_count": 10,
"skipped_file_count": 5,
"skipped_folder_count": 5,
"state": "succeeded"
}