Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

DownloadList
List<FileHandleAssociation> filesToDownload
Date updatedOn


DownloadOrder
String orderId
List<FileHandleAssociation> files
Date createdOn
String createdBy
String zipFileName
Long totalSizeMB


DownloadOrderSummary
String orderId
Date createdOn
String zipFileName
Long numberOfFiles
Long totalSizeMB


<<Interface>>

AddRequest


AddFolderRequest extends implements AddRequest
String parentId


AddQueryRequest extends implements AddRequest
Query query


DownloadOrderRequest
String zipFileName



/add
NamePhaseDescriptionResponsePathRequest
startAddJob()File SelectionStart an asynchronous job to add all of the files from either a folder or a view query to the user's DownloadListJobIdAsyncJobIdPUT POST /download/list/<userid>/add/async/startAddRequest
File SelectionGet the results of an asynchronous job to add files to a user's download list.DownloadListGET /addAddRequestgetJobResultsJobIdGET download/list/<userid>/add/async/get/<jobid>
File SelectionAdd a single file to a user's download list.DownloadListPOST /download/list/<userid>/addFileHandleAssociation
Selection ReviewGet a user's download list.DownloadListGET /download/list/<userid>
Selection ReviewRemove a file from a user's download list
POST /download/list/<userid>/removeFileHandleAssociation
Selection ReviewClear a user's download list
DELETE /download/list/<userid>
DownloadCreate a DownloadOrder from the user's current download list.DownloadOrderPUT /download/list/<userid>/orderDownloadOrderRequest
Download Order ReviewGet a DownloadOrder given its ID.DownloadOrderGET /download/order/<orderId>
Download Order ReviewStart an asynchronous job to download a download order.AsyncJobIdPOST /download/order/<orderId>/async/start
Download ReviewGet the results of an asynchronous job to download a download order.BulkFileDownloadResponsePOST /download/order/<orderId>/async/get/<jobId>
Download HistoryGet a user's previous download order history in reverse chronological order.Paginated<DownloadOrderSummary>GET /download/order/<userId>/history