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",
"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. |
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. |
Response
{
"success": true,
"errors": [],
"messages": [
"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