PUT Complete Multipart Upload
Overview
The following table contains important information about the PUT method in regards to complete multipart upload.
| PUT Method | |
|---|---|
| Method | PUT |
| URL or Endpoint | /api/projects/projectId/uploads/multipart-complete |
| Headers | Authorization |
| Parameters | projectId |
| Body | requestKey, parts, partNumber, eTag |
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": "string",
"allowPartialComplete": true,
"parts": [
{
"partNumber": 0,
"eTag": "string"
}
]
}
The description of the parameters is as follows:
| Body Parameter Name | Mandatory | Type | Description |
|---|---|---|---|
| requestKey | Yes | string | A unique key associated with the upload request. |
| allowPartialComplete | No | boolean | Determines whether to allow partial completion of the upload. |
| parts | Yes | array[object] | List of parts for the upload, including part numbers and eTags. |
| partNumber | Yes | integer | The part number for each segment of the uploaded file. |
| eTag | Yes | string | The eTag for the uploaded part, used to verify part integrity. |
If the allowPartialComplete parameter is not provided in the request body, it defaults to true.
When set to true, the API automatically attempts to complete the multipart upload. All provided parts will be processed, and the upload will be finalized if all parts are valid. When set to false, and not all parts were completed the API returns an HTTP 400 Bad Request error. This gives you control over incomplete uploads and requires you to decide the next steps:
- Resume Upload: You can resume the multipart upload and upload the remaining parts that were not yet completed.
- Abort Upload: You can abort the entire multipart upload process using the Abort Multipart Upload endpoint.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": true,
"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 | bool | Indicates the primary outcome of the request, returning true if successful. |
| 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