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

Download Open API Spec

ExternalObjectStoreUploadDestination

org.sagebionetworks.repo.model.file.ExternalObjectStoreUploadDestination

The upload destination contains information necessary to start an upload to an S3 bucket not managed by Synapse. This destination is mapped from an ExternalObjectStorageLocationSetting.

Field Type Description
concreteType STRING Indicates which implementation this object represents.
storageLocationId INTEGER the unique id for the storage location, that points to the StorageLocationSetting
uploadType UploadType The enumeration of possible upload types.
banner STRING If set, the client should show this banner every time an upload is initiated
destinationProjectId STRING The ID of the project where this file will be uploaded.
projectStorageLocationUsage ProjectStorageLocationUsage Represent the current size and limits for a single project storage location.
endpointUrl STRING endpoint URL of the S3 service (for example: 'https://s3.amazonaws.com')
bucket STRING the bucket to use
keyPrefixUUID STRING A UUID prefix used to identify the file to be uploaded. This field will have a new, unique value every time a new UploadDestination is retrieved.