GET Uploaded Parts
Overview
The following table contains important information about the GET
method in regards to retrieve uploaded parts.
GET Uploaded Parts | |
---|---|
Method | GET |
URL or Endpoint | /api/projects/projectId /uploads/url/multipart/requestKey /parts |
Headers | Authorization |
Parameters | requestKey, projectId |
Body | Not applicable |
The description of the URL parameter is as follows:
requestKey URL Parameter | |
---|---|
URL Parameter Name | requestKey |
Mandatory | Yes |
Type | string |
Description | Key that is provided after a successful upload |
projectId URL Parameter | |
---|---|
URL Parameter Name | projectId |
Mandatory | Yes |
Type | string |
Description | Unique Id of the project. |
Request Body
The GET
request does not have a request body
Response
{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"size": 23,
"lastModified": "2024-10-29T09:53:22+01:00",
"partNumber": 3,
"eTag": "eTag"
}
],
"resultInfo": null,
"statusCode": 200
}
The description to the fields in the code are written in the table below.
Parameter Name | Type | Description |
---|---|---|
success | bool | If the response is successful, it will return true. Otherwise, it will return false. |
errors | array[string] | List of errors, if any occurred during the request. |
messages | array[string] | Response messages from the back-end. |
result | array[Object] | List containing details of the processed file parts. |
size | integer | The size of the file part in bytes. |
lastModified | string | The date and time when the file part was last modified. |
partNumber | integer | The sequence number of the file part. |
eTag | string | An entity tag (eTag) representing the unique identifier for the file part’s content. |
resultInfo | string | Additional information about the result, if any. |
statusCode | integer ($int32) | The HTTP status code of the response. |
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