The Open API specification for Synapse is now available for download!

Download Open API Spec

POST /download/order

Create a download Order from the user's current download list. Only files that the user has permission to download will be added to the download order. Any file that cannot be added to the order will remain in the user's download list.

The resulting download order can then be downloaded using POST /file/bulk/async/start.

Note: A single download order is limited to 1 GB of uncompressed file data. This method will attempt to create the largest possible order that is within the limit. Any file that cannot be added to the order will remain in the user's download list.

Resource URL

https://repo-prod.prod.sagebase.org/file/v1/download/order

Parameters
zipFileName

optional

The name to given to the resulting zip file.
Resource Information
Authentication Required
Required OAuth Scopes view , modify , download
HTTP Method POST
Request Object None
Response Object DownloadOrder
(application/json)