POST Upload Success
Overview
The following table contains important information about the POST method when the action is successful in regards to the upload process.
| POST Method | |
|---|---|
| Method | POST |
| URL or Endpoint | /api/projects/projectId/uploads/success/requestKey |
| Headers | Authorization |
| Parameters | projectId, requestKey |
| Body | Not Applicable |
The description of the URL parameters is as follows:
projectId URL Parameter | |
|---|---|
| URL Parameter Name | projectId |
| Mandatory | Yes |
| Type | string |
| Description | Unique identifier for project |
requestKey URL Parameter | |
|---|---|
| URL Parameter Name | requestKey |
| Mandatory | Yes |
| Type | string |
| Description | Key that is provided after a successful upload. |
Request Body
The POST method doesn't require a request body.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"downloadPath": "downloadPath",
"contentType": "contentType"
},
"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 response object. |
downloadPath | string | Returns the download path of the video. |
contentType | string | Specifies the content type of the downloaded file. |
| resultInfo | string | Returns extra information about the result. |
| errors | array[string] | Indicates if there was an error. |
| messages | array[string] | Returns the response message from the back-end. |
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