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

Download Open API Spec

FileResult

org.sagebionetworks.repo.model.file.FileResult

Result of a single File request.

Field Type Description
fileHandleId STRING The ID of the requested FileHandle.
fileHandle FileHandle The FileHandle interface defines all of the fields that are common to all implementations.
preSignedURL STRING A pre-signed URL to download the requested file. Null if the request.includePreSignedURLs=false.
previewPreSignedURL STRING A pre-signed URL to download the preview of requested file. Null if the request.includePreviewPreSignedURLs=false.
failureCode FileResultFailureCode Failure code for a files that cannot be downloaded.