View VOD Object
Method for viewing information about a VOD object
Request Parameters
GET /api/clients/v1/vod/{id}/
Headers
- Content-Type: application/json
- Authorization: Bearer
$access_token
Path
| Parameter | Type | Constraints | Description | Example |
|---|---|---|---|---|
| id | integer | > 0, required | VOD object ID | 19 |
Response Parameters
JSON body
| Parameter | Type | Description |
|---|---|---|
| id | integer | VOD object ID |
| vod_domain | string | VOD domain name |
| source_type | string | Video source type |
| source_id | integer | Video source ID |
| is_active | boolean | VOD function status |
Examples
200 OK
VOD object
{
"id": 19,
"vod_domain": "vs52.vod-clients.cdn.itglobal.com",
"source_type": "s3_bucket",
"source_id": 52,
"is_active": false
}
400 Bad Request
Invalid path parameters provided
{
"id": [
"A valid integer is required."
]
}
401 Unauthorized
Authentication credentials were missing or invalid
{
"detail": "Given token not valid for any token type",
"code": "token_not_valid",
"messages": [
{
"token_class": "AccessToken",
"token_type": "access",
"message": "Token is invalid or expired"
}
]
}
403 Forbidden
Viewing VOD objects is only allowed for project participants associated with its source
{
"detail": "Only project participants can manage this project's VOD"
}
404 Not Found
VOD object with this ID not found
{
"detail": "VOD not found"
}