Video API, REST: Episode.PerformAction
Perform an action on the episode.
HTTP request
POST https://video.api.cloud.yandex.net/video/v1/episodes/{episodeId}:performAction
Path parameters
Field |
Description |
episodeId |
string Required field. ID of the episode. |
Body parameters
{
// Includes only one of the fields `publish`, `unpublish`
"publish": "object",
"unpublish": "object"
// end of the list of possible fields
}
Field |
Description |
publish |
object Includes only one of the fields |
unpublish |
object Includes only one of the fields |
Response
HTTP Code: 200 - OK
{
"id": "string",
"description": "string",
"createdAt": "string",
"createdBy": "string",
"modifiedAt": "string",
"done": "boolean",
"metadata": {
"episodeId": "string"
},
// Includes only one of the fields `error`, `response`
"error": {
"code": "integer",
"message": "string",
"details": [
"object"
]
},
"response": {
"id": "string",
"streamId": "string",
"lineId": "string",
"title": "string",
"description": "string",
"thumbnailId": "string",
"startTime": "string",
"finishTime": "string",
"dvrSeconds": "string",
"visibilityStatus": "string",
// Includes only one of the fields `publicAccess`, `authSystemAccess`
"publicAccess": "object",
"authSystemAccess": "object",
// end of the list of possible fields
"createdAt": "string",
"updatedAt": "string"
}
// end of the list of possible fields
}
An Operation resource. For more information, see Operation.
Field |
Description |
id |
string ID of the operation. |
description |
string Description of the operation. 0-256 characters long. |
createdAt |
string (date-time) Creation timestamp. String in RFC3339 To work with values in this field, use the APIs described in the |
createdBy |
string ID of the user or service account who initiated the operation. |
modifiedAt |
string (date-time) The time when the Operation resource was last modified. String in RFC3339 To work with values in this field, use the APIs described in the |
done |
boolean If the value is |
metadata |
Service-specific metadata associated with the operation. |
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |
PerformEpisodeActionMetadata
Field |
Description |
episodeId |
string ID of the episode. |
Status
The error result of the operation in case of failure or cancellation.
Field |
Description |
code |
integer (int32) Error code. An enum value of google.rpc.Code |
message |
string An error message. |
details[] |
object A list of messages that carry the error details. |
Episode
Field |
Description |
id |
string ID of the episode. |
streamId |
string ID of the stream. Optional, empty if the episode is linked to the line |
lineId |
string ID of the line. Optional, empty if the episode is linked to the stream |
title |
string Channel title. |
description |
string Channel description. |
thumbnailId |
string ID of the thumbnail. |
startTime |
string (date-time) Episode start time. String in RFC3339 To work with values in this field, use the APIs described in the |
finishTime |
string (date-time) Episode finish time. String in RFC3339 To work with values in this field, use the APIs described in the |
dvrSeconds |
string (int64) Enables episode DVR mode. DVR seconds determines how many last seconds of the stream are available. possible values:
|
visibilityStatus |
enum (VisibilityStatus)
|
publicAccess |
object Episode is available to everyone. Includes only one of the fields Episode access rights. |
authSystemAccess |
object Checking access rights using the authorization system. Includes only one of the fields Episode access rights. |
createdAt |
string (date-time) Time when episode was created. String in RFC3339 To work with values in this field, use the APIs described in the |
updatedAt |
string (date-time) Time of last episode update. String in RFC3339 To work with values in this field, use the APIs described in the |