...
| 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) | /addChunkToFilestartCompleteUploadDaemon | POST | ChunkRequest CompleteAllChunksRequest(application/json) | After a chunk is all of the chuncks have been PUT to a the pre-signed 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/completeChunkFileUpload{daemonId} | POST | 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 FileHandlesGET | 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
...