Skip to main content

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
MethodPOST
URL or Endpoint/api/projects/projectId/uploads/multipart-resume
HeadersAuthorization
ParametersprojectId
BodyCheck request body below.

The description of the URL parameter is as follows:

projectId Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

{
"requestKey": "{requestKey}",
"presignedUrlExpiryTimeHours": 0
}

The description of the parameters is as follows:

Body Parameter NameMandatoryTypeDescription
requestKeyYesstringUnique Request Key
presignedUrlExpiryTimeHoursNointegerPresigned 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 NameTypeDescription
successboolIf the response is successful it will return true. Otherwise, it will return false.
errorsarray[string]Indicates if there was an error.
messagesarray[string]Returns the response message from the back-end.
resultobjectReturns the main response object containing upload details.
uploadIdstringUnique identifier for the upload session.
requestKeystringA unique key associated with the request.
presignedUrlarray[object]Array of objects, each containing a part number and the corresponding presigned URL for uploading.
partNumberintegerThe part number for each segment of the upload.
presignedUrlstringThe presigned URL to upload a specific part of the file.
uploadFileDetailsIdinteger($int32)The ID of upload file details.
resultInfostringReturns extra information about the result, if any.
statusCodeinteger($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