日本時間5月16日のContent Cloud Summitで、カスタムアプリにBox AI APIを活用する方法を紹介します。

詳細を表示

zipダウンロード

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

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

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

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

string / date-time
2019-08-29T23:59:00-07:00

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

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

array array

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

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

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

object array

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

string
12345

項目の識別子

string
file

この項目のタイプ

次の値のいずれか1つ: file,folder

3aa6a7.pdf

ダウンロードされたzipアーカイブで表示される項目の新しい名前。

Report.pdf

この項目の元の名前

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

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

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

レスポンスの例

{
  "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"
      }
    ]
  ]
}