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

Download Open API Spec

AddToDownloadListRequest

org.sagebionetworks.repo.model.download.AddToDownloadListRequest

Start an asynchronous job to add files from the given view query or folder to the user's download list,

Field Type Description
concreteType STRING
query Query
parentId STRING The synID of a folder, project, or dataset to add all of the children files to the user's download list. This parameter should be excluded when adding files from a query. Note: This is not recursive.
useVersionNumber BOOLEAN When true (default), the version number will be included for each file added to the user's download list. When set to false, the version number will be excluded, indicating that the 'current' version should always be downloaded.