General Notes
- All paths above are relative to the REST endpoint base (something like http://your.server/files)
- If the service is down or not working it will return a status 503, this means the the underlying service is not working and is either restarting or has failed
- A status code 500 means a general failure has occurred which is not recoverable and was not anticipated. In other words, there is a bug! You should file an error report with your server logs from the time when the error occurred: Opencast Issue Tracker
Table of Contents
Read methods
| Method / Path: | GET /series.json |
|---|---|
| Description: | Search for series matching the query parameters. |
| Path params: | NONE |
| Optional (query) params: |
id:
The series ID. If the additional boolean parameter "episodes" is "true", the result set will include this series episodes. q: Any series that matches this free-text query. sort: The sort order. May include any of the following dublin core metadata: identifier, title, contributor, creator, created, modified. Add ' asc' or ' desc' to specify the sort order (e.g. 'title desc'). limit(Default value=20): The maximum number of items to return per page. offset(Default value=0): The page number. |
| Response formats: | application/json |
| Status codes: | 200: OK, The request was processed successfully. |
| Notes: |
|
| Testing: |
Sample:
/series.json?id={id}&q={q}&sort={sort}&limit=20&offset=0
Testing form (click to reveal)
|
| Method / Path: | GET /episode.json |
|---|---|
| Description: | Search for episodes matching the query parameters. |
| Path params: | NONE |
| Optional (query) params: |
id:
The ID of the single episode to be returned, if it exists. q: Any episode that matches this free-text query. sid: Any episode that belongs to specified series id. sname: Any episode that belongs to specified series name (note that the specified series name must be unique). sort: The sort order. May include any of the following dublin core metadata: title, contributor, creator, created, modified. Add ' asc' or ' desc' to specify the sort order (e.g. 'title desc'). limit(Default value=20): The maximum number of items to return per page. Limited to 250 for non-admins. offset(Default value=0): The page number. sign(Default value=true): If results are to be signed live: If the result should only consist of live episodes (true) or not live episodes (false) |
| Response formats: | application/json |
| Status codes: | 200: OK, The request was processed successfully. |
| Notes: |
|
| Testing: |
Sample:
/episode.json?id={id}&q={q}&sid={sid}&sname={sname}&sort={sort}&limit=20&offset=0&sign=true&live={live}
Testing form (click to reveal)
|
Write methods
| Method / Path: | POST /updateIndex |
|---|---|
| Description: | Trigger search index update for event. The usage of this is limited to global administrators. |
| Path params: | NONE |
| Required (form) params: | id: The event ID to trigger an index update for. |
| Optional (form) params: | NONE |
| Status codes: |
204: No Content, Update successfully triggered. 403: Forbidden, Not allowed to trigger update. 404: Not Found, No such event found. |
| Notes: |
|
| Testing: |
Sample:
/updateIndex
Testing form (click to reveal)
|