Video API, REST: Playlist.Get
Returns the specific playlist.
HTTP request
GET https://video.api.yandexcloud.kz/video/v1/playlists/{playlistId}
Path parameters
|
Field |
Description |
|
playlistId |
string Required field. ID of the playlist. |
Response
HTTP Code: 200 - OK
{
"id": "string",
"channelId": "string",
"title": "string",
"description": "string",
"items": [
{
// Includes only one of the fields `videoId`, `episodeId`
"videoId": "string",
"episodeId": "string",
// end of the list of possible fields
"position": "string"
}
],
"createdAt": "string",
"updatedAt": "string"
}
Entity representing an ordered list of videos or episodes.
|
Field |
Description |
|
id |
string ID of the playlist. |
|
channelId |
string ID of the channel to create the playlist in. |
|
title |
string Playlist title. |
|
description |
string Playlist description. |
|
items[] |
List of playlist items. |
|
createdAt |
string (date-time) Time when playlist was created. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
|
updatedAt |
string (date-time) Time of last playlist update. String in RFC3339 text format. The range of possible values is from To work with values in this field, use the APIs described in the |
PlaylistItem
|
Field |
Description |
|
videoId |
string ID of the video. Includes only one of the fields |
|
episodeId |
string ID of the episode. Includes only one of the fields |
|
position |
string (int64) Item position (zero-indexed). |