POST Resume Multipart Upload
Overview
The following table contains important information about the POST method in regards to resuming a multipart upload that was not completed or aborted.
| POST Method | |
|---|---|
| Method | POST |
| URL or Endpoint | /api/projects/projectId/uploads/multipart-resume |
| Headers | Authorization |
| Parameters | projectId |
| Body | Check request body below. |
The description of the URL parameter is as follows:
| projectId Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique Id of the project. |
Request Body
{
"requestKey": "{requestKey}",
"presignedUrlExpiryTimeHours": 0
}
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
| requestKey | Yes | string | Unique Request Key |
| presignedUrlExpiryTimeHours | No | integer | Presigned URL expiry time in hours. Value must be between 1 and 168. If sent as null or omitted, it defaults to 12 hours. |
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"uploadId": "{uploadId}",
"requestKey": "{requestKey}",
"presignedUrl": [
{
"partNumber": 0,
"presignedUrl": "{presignedUrl}"
}
],
"uploadFileDetailsId": 0
},
"resultInfo": null,
"statusCode": 200
}
Information about the fields that appear when you receive the response are displayed in the table below.
| Field Name | Type | Description |
|---|---|---|
| success | bool | If the response is successful it will return true. Otherwise, it will return false. |
| errors | array[string] | Indicates if there was an error. |
| messages | array[string] | Returns the response message from the back-end. |
| result | object | Returns the main response object containing upload details. |
| uploadId | string | Unique identifier for the upload session. |
| requestKey | string | A unique key associated with the request. |
| presignedUrl | array[object] | Array of objects, each containing a part number and the corresponding presigned URL for uploading. |
| partNumber | integer | The part number for each segment of the upload. |
| presignedUrl | string | The presigned URL to upload a specific part of the file. |
| uploadFileDetailsId | integer($int32) | The ID of upload file details. |
| resultInfo | string | Returns extra information about the result, if any. |
| statusCode | integer($int32) | Returns the HTTP Status Code. |
If the action is successful, the service sends back an HTTP 200 or 201 response.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed