Information
The Playlists API is available since API version 1.11.0.
GET /api/playlists/{id}
Returns a playlist.
Response
200 (OK)
: A playlist as JSON.
400 (BAD REQUEST)
: The request is invalid or inconsistent.
403 (FORBIDDEN)
: The user doesn't have the rights to make this request.
404 (NOT FOUND)
: The specified playlist does not exist.
Example
{
"playlist": {
"id": 551,
"organization": "mh_default_org",
"entries": [
{
"id": 553,
"contentId": "ID-about-opencast",
"type": "EVENT"
},
{
"id": 554,
"contentId": "ID-3d-print",
"type": "EVENT"
}
],
"title": "Opencast Playlist",
"description": "This is a playlist about Opencast",
"creator": "Opencast",
"updated": 1701854481056,
"accessControlEntries": [
{
"allow": true,
"role": "ROLE_USER_BOB",
"action": "read"
}
]
}
}
GET /api/playlists/
Get playlists. Playlists that you do not have read access to will not show up.
Response
200 (OK)
: A JSON object containing an array.
400 (BAD REQUEST)
: The request is invalid or inconsistent.
Field | Type | Description |
---|---|---|
limit |
int |
The maximum number of results to return for a single request |
offset |
int |
The index of the first result to return |
sort |
string |
Sort the results based upon a sorting criteria. A criteria is specified as a pair such as: |
Example
{
"playlist": [
{
"playlist": {
"id": 551,
"organization": "mh_default_org",
"entries": [
{
"id": 553,
"contentId": "ID-about-opencast",
"type": "EVENT"
},
{
"id": 554,
"contentId": "ID-3d-print",
"type": "EVENT"
}
],
"title": "Opencast Playlist",
"description": "This is a playlist about Opencast",
"creator": "Opencast",
"updated": 1701854481056,
"accessControlEntries": [
{
"allow": true,
"role": "ROLE_USER_BOB",
"action": "read"
}
]
}
},
{
"playlist": {
"id": 1051,
"organization": "mh_default_org",
"entries": [
{
"id": 1053,
"contentId": "ID-about-opencast",
"type": "EVENT"
},
{
"id": 1054,
"contentId": "ID-3d-print",
"type": "EVENT"
}
],
"title": "Opencast Playlist",
"description": "This is a playlist about Opencast",
"creator": "Opencast",
"updated": 1701856455007,
"accessControlEntries": [
{
"allow": true,
"role": "ROLE_USER_BOB",
"action": "read"
}
]
}
}
]
}
POST /api/playlists/
Creates a new playlist.
Response
201 (CREATED)
: The created playlist.
400 (BAD REQUEST)
: The request is invalid or inconsistent.
403 (FORBIDDEN)
: The user doesn't have the rights to make this request.
Field | Type | Description |
---|---|---|
playlist |
Playlist |
Playlist in JSON format |
Example
{
"playlist": {
"organization": "mh_default_org",
"entries": [
{
"id": 553,
"contentId": "ID-about-opencast",
"type": "EVENT"
},
{
"id": 554,
"contentId": "ID-3d-print",
"type": "EVENT"
}
],
"title": "Opencast Playlist",
"description": "This is a playlist about Opencast",
"creator": "Opencast",
"updated": 1701854481056,
"accessControlEntries": [
{
"allow": true,
"role": "ROLE_USER_BOB",
"action": "read"
}
]
}
}
PUT /api/playlists/{id}
Updates a playlist.
Response
200 (OK)
: The updated playlist.
400 (BAD REQUEST)
: The request is invalid or inconsistent.
403 (FORBIDDEN)
: The user doesn't have the rights to make this request.
Field | Type | Description |
---|---|---|
playlist |
Playlist |
Playlist in JSON format |
Example
{
"playlist": {
"organization": "mh_default_org",
"entries": [
{
"id": 553,
"contentId": "ID-about-opencast",
"type": "EVENT"
},
{
"id": 554,
"contentId": "ID-3d-print",
"type": "EVENT"
}
],
"title": "Opencast Playlist",
"description": "This is a playlist about Opencast",
"creator": "Opencast",
"updated": 1701854481056,
"accessControlEntries": [
{
"allow": true,
"role": "ROLE_USER_BOB",
"action": "read"
}
]
}
}
DELETE /api/playlists/{id}
Removes a playlist.
Response
200 (OK)
: The removed playlist.
403 (FORBIDDEN)
: The user doesn't have the rights to make this request.
404 (NOT FOUND)
: The specified playlist does not exist.