...
We propose adding a new REST API call that would allow callers to start an asynchronous job that would create a zip file containing multiple requested files. Upon completion of the job, a pre-signed URL will be returned with the response object. The response object will also include a summary of each of the requested file. Each file summary will include a state of SUCCESS or FAILURE to indicate which of the requested files were included in resulting zip file. For the case of FAILURE, a reason will be included, such as UNAUTHORIZED or NOT_FOUND.
...
The zip file entry naming scheme is designed to match the caching schemes used by the R and Python clients such that the zip file can decompressed directly into a users local file cache.
Limits
There will be a limit of 1 GB for a single result zip file. If the sum of all of the requested files exceeds this size limit a zip will be generated with as many files as possible up to the limit. All files that are excluded due to exceeding the limit will be marked as FailureCode.SIZE_LIMIT_EXCEEDED.
Download Audit Record
For each file included in a bulk download zip file, an audit record will captures the following data:
- FileHandleId
- AssociatedObjectId
- AssociatedObjectType
- UserId
- Timestamp
Object Model
REST API
| URL | Method | Request Body | Response Body | Authorization | Description |
|---|---|---|---|---|---|
| /file/bulk/async/start | POST | BulkFileDownloadRequest | AsynchJobId | Anyone is authorized to make this call. Authorization for each requested file is done individually. Any file that the caller is not authorized to download will not be included in the resulting zip file and the. | Call to start an asynchronous job create a Zip file containing all of the requested files that the caller is authorized to download. |
| file/bulk/async/get/{asyncToken} | GET | Job complete: BulkFileDownloadResponse (200) Job processing: AsynchronousJobStatus (202) | Only the user that started the job is authorized to make this call. | Call used to track the asynchronous job status. While the job is still running the job status will be returned (202), when the job is complete results will be returned (200). | |
| GET /fileHandle/{handleId}/url | GET | Pre-signed URL | The creator of the FileHandle is authorized to make this call. If the caller is authorized to download the file via an associated object they they will be authorized to make this call. | This method already exist in the API. However, only the creator of the fileHandle is authorized to make this call presently. Authorization will be extend to allow anyone that is authorized to download the object via an associated object. |
...