Note: The FileHandle API is currently in alpha. Not all feature are supported.
FileHandle
The FileHandle is an object that represents a file that has either been upload uploaded to Synapse, or resides external to Synapse. The FileHandle provides basic metadata about file:
| Field | Description |
|---|
| id | The unique |
identified | identifier of a file handle. This ID is used to reference a file handle. |
| etag | The etag of a file handle will change if the file handle changes. For the most part FileHandles are immutable, with the only exception being assigning a preview |
file handle | FileHandle ID. |
| createdBy | The ID of the user that created this FileHandle. Only |
this | the user that created a FileHandle can assign it to a file entity or wiki attachment. |
| createdOn | The date on which the file handle was created |
on| . |
| concreteType | FileHandle is an |
interfaces, | interface with at least three implementations. This field is used to indicate which concrete implementation is used. |
| fileName | The name of the file. This field is required. |
There are currently three concrete implementation implementations of FileHandle:
| Object name | concreteType |
|---|
| ExternalFileHandle | org.sagebionetworks.repo.model.file.ExternalFileHandle |
| S3FileHandle | org.sagebionetworks.repo.model.file.S3FileHandle |
| PreviewFileHandle | org.sagebionetworks.repo.model.file.PreviewFileHandle |
ExternalFileHandle
An external file handle is used to represent an external URL. Notice Note that ExternalFileHandle implements HasPreviewId. Synapse will try to automatically generate a preview for any external URL that can be publicly read. The resulting preview file will be stored in Synapse and respresented represented with a PrevewFileHandle. The creator of the ExternalFileHandle will be listed as the creator of the preview.
S3FileHandle
When a file is stored in Synapse, by default it is stored in Amazon's S3. The S3FileHandle captures the extra information about the S3 file. Just like ExternalFileHandles, Synapse will attempt to automatically create a preview of all S3FileHandles.
PreviewFileHandle
When Synapse creates a preview file for either an ExternalFileHandle or an S3FileHandle, the resulting preview file will be stored in S3 and be assigned a PreviwFileHandlePreviewFileHandle. Currently, Synapse will generate previews based on the original file's contentType. See Internet Media Type.
HTTP Types
For any web services where a file is sent with a POST, the content-type must be 'multipart/form-data', see:HTTP Multipart. The content-type of all service responses will be 'application/json'.
Note: Unless otherwise specified all FileHandle services uses use a new endpoint: https://file-prod.sagebase.org/file/v1. Also standard Synapse 'sessionToken' must be included in all requests.
API
/fileHandle | POST | Post a list of Files (content-type= 'multipart/form-data'). For each File included in the POST, a FileHandle will be created and returned. The ID of the returned FileHandles can be used to assign the file to a Synapse objects such as WikiPage attachments or FileEntity.
This method is deprecated. Please use the Chunk File Upload. |
|---|
| /externalFileHandle | POST | Post an external File Handle. Note: The body of the request is an ExternalFileHandle object, wrapping the URL to be stored. |
| /fileHandle/{handleId} | GET | Get the FileHandle for a given FileHandle ID. Only the original creator of the FileHandle is authorized to get a FileHandle or assign a FileHandle to a Synapse Object such as WikiPage attachment or FileEntity. |
| /fileHandle/{handleId} | DELETE | Delete a FileHandle by its ID. This will also trigger the delete of the corresponding file in S3 (when relevant) and any preview automatically generated for the FileHandle. |
/fileHandle/{handleId} (Proposed) | PUT | Updates an existing file handle. Only the owner of a file handle or an administrator may update a file handle. The following fields may be modified by a file handle owner: fileName, and contentType. The following fields may be modified by an administrator only: bucketName (S3 FileHandles only). If bucketName is modified, the underlying file will be copied to the new location. The key may also be modified. bucketName must be changed to an existing bucket that Synapse has access to. |
Chunked File Upload API
While it is possible to upload very larger large files with a single HTTP request, it is not recommended to do so. If anything were to go wrong the only option would be start over from the beginning. The longer a file upload takes the less likely restarting will be acceptable to users. To address this type of issue, Synapse provides 'chunked' file upload as the recommended method for upload all files. This means the client-side software divides larger files into chunks and sends each chunk separately. The server code will then reassemble all of the chunks into a single file once the upload is complete. Any file that is less than or equal to 5 MB should be uploaded as a single chunk. All larger files should be chunked into 5 MB chunks, each sent separately. If any chunk fails, simply resend the failed chunk. While this puts an extra burden on client-side developers the results are more robust and responsive code. The following table shows the four web-service calls used for chunked file upload. For these calls the request and response objects are not the same, so both will be shown:
...
| Response (type) | URL | HTTP Type | Request (type) | Description |
|---|
| 1 | ChunkedFileToken (application/json) | /createChunkedFileUploadToken | POST | CreateChunkedFileTokenRequest (application/json) | Create a ChunkedFileToken. This token must be provided in all subsequent requests. |
| 2 | URL (text/plain) | /createChunkedFileUploadChunkURL | POST | ChunkRequest (application/json) | Create a pre-signed URL that will be used to PUT a single file chunk. This step is repeated for each chunk. |
| 3 |
ChunkResult | UploadDaemonStatus (application/json) | / |
addChunkToFile| startCompleteUploadDaemon | POST |
ChunkRequest | CompleteAllChunksRequest(application/json) | After |
a chunk is | all of the chuncks have been PUT to |
a URL, it must be added to file. You will need the returned ChunkResult to complete the upload. This step is repeated for each chunk.4 | S3FileHandle | URLs a daemon is started to put all of the parts back to together again into a single large file. The call will start a Daemon and return a UploadDaemonStatus object. The caller will need to pull for the daemon status using next call (/completeUploadDaemonStatus) below and wait for the daemon to transition from a state=PROCESSING to state=COMPLETE, at which time the status will contain the newly created FileHandleId. |
| 4 | UploadDaemonStatus (application/json) | /completeUploadDaemonStatus/ |
completeChunkFileUploadPOST | CompleteChunkedFileRequest (application/json) | After all chunks have been added, complete the upload with this call. The resulting S3FileHandle can be used for any object that accepts FileHandles.| GET | none | Get the status of the daemon started in the previous call. The client should pull this status until the state changes to to either COMPLETE or FAILED. Once the state changes to COMPLETE the status object will contain the resulting FileHandleID. If the daemon fails, (state=FAILED), the status object will contain an errorMessage that provides some information about what went wrong. While the state is PROCESSING, the percentComplete field of the status will inform about the progress being made. |
Associating FileHandles with Synapse objects
FileEntity
See: Entities, Files, and Folders Oh My!
Wiki pages
See: Wiki API (Alpha)
