GET Videos by PublicId
Overview
The following table contains information about the GET
method in regards to the managing process, more precisely when you want to make a GET
by using the PublicId
.
GET Videos by PublicId | |
---|---|
Method | GET |
URL or Endpoint | /api/projects/projectId /videos/id |
Headers | Authorization |
Parameters | id, projectId |
Body | Not Applicable |
The description of the URL parameter is as follows:
URL Parameter Name | Mandatory | Type | Description |
---|---|---|---|
projectId | Yes | string | Unique Id of the project. |
id | Yes | string | Unique id of the encoded video. |
Request Body
The GET
method doesn't contain a request body.
Response
{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": 1126,
"publicId": "vjsmxjms",
"name": "string",
"title": "string",
"description": "string",
"publishDate": "2021-07-03T15:45:11.529",
"publishEndDate": "2021-07-03T15:45:11.529",
"publishStatusId": null,
"duration": null,
"entityId": 1086,
"videoPagePermalink": "string",
"userName": null,
"tags": null,
"category": {
"id": 23,
"entityId": 1086,
"categoryId": 11,
"categoryName": "Sports",
"userId": 0
},
"restriction": {
"id": 10,
"entityId": 1086,
"entityRestrictionId": 283146,
"entityRestrictionName": null
},
"adSchedule": {
"id": 4,
"entityId": 1086,
"adScheduleId": 6,
"adScheduleName": "AdSchedule1"
}
},
"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 | array[Object] | Returns the response object |
id | integer($int32) | Unique id of video |
publicId | string | The unique Id of the encoded video |
name | string | Title of the video |
title | string | Title of the video |
description | string | Description of the video |
publishDate | Date | Date when published |
publishEndDate | Date | Date when end published |
publishStatusId | integer($int32) | Id when published |
duration | integer($int32) | Duration of the video |
entityId | integer($int32) | Id of entity |
videoPagePermalink | string | Permalink |
userName | string | Username that uploaded video |
tags | string | Tags of the video |
category | Object | Category of the video |
id | integer($int32) | Id of the record |
entityId | integer($int32) | Id of entity |
categoryId | integer($int32) | Id of the category |
categoryName | string | Name of the category |
userId | integer($int32) | Id of the user |
restriction | Object | Restriction object |
id | integer($int32) | Id of restriction |
entityId | integer($int32) | Id of entity |
entityRestrictionId | integer($int32) | Id of entity restrictions |
entityRestrictionName | string | Name of entity restriction |
adSchedule | Object | Ad schedule object |
id | integer($int32) | Id of record |
entityId | integer($int32) | Entity Id |
adScheduleId | integer($int32) | Id of ad schedule |
adScheduleName | string | Name of ad schedule |
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