POST Video
Overview
The following table contains important information about the POST
method for managing the process of uploading a new video.
POST Video | |
---|---|
Method | POST |
URL or Endpoint | /api/projects/projectId /videos/id |
Parameters | projectId |
Body | Not applicable |
The description of the URL parameters is as follows:
URL Parameter Name | Mandatory | Type | Description |
---|---|---|---|
projectId | Yes | string | Unique Id of the project. |
Request Body
The request does not contain a request body .
Response
{
"success": true,
"errors": [],
"messages": [],
"result": "{videoId}",
"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 will return false |
errors | array[string] | Indicates if there was an error |
messages | array[string] | Returns the response message from back-end |
result | string | Returns the unique identifier of the new video |
resultInfo | string | Returns extra information about the result |
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