メインコンテンツへスキップ
POST
/
zip_downloads
cURL
curl -i -X POST "https://api.box.com/2.0/zip_downloads" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "download_file_name": "January Financials",
       "items": [
         {
           "type": "file",
           "id": "12345"
         },
         {
           "type": "file",
           "id": "34325"
         },
         {
           "type": "folder",
           "id": "45678"
         }
       ]
     }'
{
  "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"
      }
    ]
  ]
}
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

​
Authorization
string
header
required

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

Body

application/json

ダウンロードするzipアーカイブを作成するリクエスト。

​
items
object[]
required

zipアーカイブに追加する項目のリスト。項目にはファイルまたはフォルダを指定できます。

​
download_file_name
string

zipアーカイブの名前 (省略可)。この名前には、January Financials.zipのように、.zipというファイル拡張子が付加されます。

Example:

"January Financials"

Response

zipアーカイブをダウンロードする準備ができている場合、このAPIによって、download_url、status_urlのほか、リクエストの作成時に発生した可能性のある競合を含むレスポンスが返されます。

ファイルやフォルダのリストのzipアーカイブを作成するリクエストが成功したことを表します。

​
download_url
string

zipアーカイブのダウンロードに使用できるURL。このURLに対するGetリクエストにより、リクエストされた項目のストリーミングが開始されます。デフォルトでは、このURLは、ダウンロードが開始されない限り、expires_atの時間までの数秒間だけ有効です。ダウンロードが開始されると、ダウンロードしている間は有効です。

このURLのドメインとパスは、APIコール間で変更される可能性があるため、このURLをそのまま使用することが重要です。

Example:

"https://dl.boxcloud.com/2.0/zip_downloads/Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd/content"

​
status_url
string

ダウンロード中のzipアーカイブのステータスを取得するために使用できるURL。このURLに対するGetリクエストにより、アーカイブ内のファイル数に加え、すでにダウンロードまたはスキップされた項目の数が返されます。デフォルトでは、このURLは、ダウンロードが開始されない限り、expires_atの時間までの数秒間だけ有効です。ダウンロードの開始後、このURLは12時間有効です。

このURLのドメインとパスは、APIコール間で変更される可能性があるため、このURLをそのまま使用することが重要です。

Example:

"https://api.box.com/2.0/zip_downloads/Lu6fA9Ob-jyysp3AAvMF4AkLEwZwAYbL=tgj2zIC=eK9RvJnJbjJl9rNh2qBgHDpyOCAOhpM=vajg2mKq8Mdd/status"

​
expires_at
string<date-time>

このアーカイブの有効期限が切れる日時。この日時を経過すると、status_urlとdownload_urlによってエラーが返されます。

デフォルトでは、このURLは、ダウンロードが開始されない限り、download_urlの時間までの数秒間だけ有効です。ダウンロードが開始されると、ダウンロードしている間は有効です。また、status_urlの有効期間は、ダウンロードを開始してから12時間です。

Example:

"2019-08-29T23:59:00-07:00"

​
name_conflicts
object[][]

アーカイブを作成しようとしたときに発生した競合のリスト。これは、複数の項目が同じ名前でリクエストされたときに発生します。

これらの競合を解決するために、APIでは、自動的に項目の名前を変更し、項目の元の名前と新しい名前の間のマッピングを返します。

競合ごとに、両方のファイル名が変更されるため、このリストは常に2の倍数になります。

アーカイブを作成しようとしたときに発生した個々の競合。これには、2個のオブジェクトからなる配列が含まれています。各オブジェクトには、名前が競合したファイルまたはフォルダの元の名前と変更後のファイル名が格納されています。