一括ダウンロード・ジョブ・ファイルのダウンロード
get
/documents/api/1.2/folders/{folderId}/_download/{jobId}/package
一括ダウンロードzipをダウンロードします。
リクエスト
サポートされるメディア・タイプ
- application/json
- application/xml
パス・パラメータ
- folderId: string
フォルダのグローバル一意識別子(GUID)。 参照されるフォルダがユーザーのホーム・フォルダの場合、
folderIdの値はselfです。 - jobId: string
一括ダウンロード・ジョブのグローバル一意識別子(GUID)。
ヘッダー・パラメータ
- Range(optional): string
標準のHTTP
Rangeヘッダーを使用すると、クライアントはファイル全体ではなくファイルの一部をストリーミングできます。Rangeヘッダーの値は、次のいずれかの形式にできます:- bytes= startByte - endByte
たとえば、最初の500バイトを受信するには、bytes=0-500を使用 - bytes= skipBytes-
たとえば、最初の500バイトをスキップするには、bytes=500-を使用 - bytes=-lastBytes
たとえば、最後の500バイトを受信するには、bytes=-500を使用
- bytes= startByte - endByte
レスポンス
サポートされるメディア・タイプ
- application/zip
200レスポンス
ファイル・コンテンツの完全なデータ・ストリーム。
206レスポンス
ファイル・コンテンツの部分的なデータ・ストリーム。
400レスポンス
返されたエラーの説明に従い、リクエストは無効です。
403レスポンス
ユーザーに読取り権限がない場合は禁止されています。
416 レスポンス
リクエストされた範囲を満たすことができません。
例
次の例では、zipファイルをダウンロードします:
GET .../documents/api/1.2/folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/11E666917053923171255718EFB36B481614961716028/package
リクエスト・ヘッダー
なし。
リクエスト本文
なし。
HTTPステータス・コード
HTTP_STATUS = 200
例2
次の例では、zipファイルの最初の1024バイトをダウンロードします:
GET .../documents/api/1.2/folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/11E666917053923171255718EFB36B481614961716028/package
リクエスト・ヘッダー
範囲: bytes=0-1023
リクエスト本文
なし。
HTTPステータス・コード
HTTP_STATUS = 206
例3
次の例では、別のユーザーが所有するzipをダウンロードしようとします。 返されるエラーは、データの露出を防ぐためにあまり詳細ではありません:
GET .../documents/api/1.2/folders/FE7DA518D17AA5E46E282D9A1B02AE3398E71823807D/_download/11E666917053923171255718EFB36B481614961716028/package
リクエスト・ヘッダー
なし。
リクエスト本文
なし。
HTTPステータス・コード
HTTP_STATUS = 400
JSONレスポンス
{
"errorCode": "-96",
"errorKey": "!csBulkdownloadUnableToGetStatusJob",
"errorMessage": "There is no bulkdownload job for the specified job Id.",
"errorType": "folder",
"title": "There is no bulkdownload job for the specified job Id.",
"type": "https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html"
}