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

Download Open API Spec

FileDownloadSummary

org.sagebionetworks.repo.model.file.FileDownloadSummary

Summary of a requested file download.

Field Type Description
fileHandleId STRING The file handle id of a requested file.
associateObjectId STRING The ID of the object associated with the file
associateObjectType FileHandleAssociateType Enumeration of all possible objects types that can be associated with a file.
zipEntryName STRING The zip entry name used for this file. This entry includes both the path and file name. The value will only be set if the status is set to 'SUCCESS'
status FileDownloadStatus The download status of this file.
failureMessage STRING If the download status of this file is set to 'FAILURE', then this will be the failure message. Null for 'SUCCESS'.
failureCode FileDownloadCode If the download status of this file is set to 'FAILURE', then this will be the failure code. Null for 'SUCCESS'.