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
Write methods
| Method / Path: | POST /convert |
|---|---|
| Description: | Convert captions from one format to another. |
| Path params: | NONE |
| Required (form) params: | captions: Captions to be converted. |
| Optional (form) params: |
input(Default value=dfxp):
Caption input format (for example: dfxp, subrip,...). output(Default value=subrip): Caption output format (for example: dfxp, subrip,...). language(Default value=en): Caption language (for those formats that store such information). |
| Response formats: | text/xml |
| Status codes: | 200: OK, OK, Conversion successfully completed. |
| Notes: |
|
| Testing: |
Sample:
/convert
Testing form (click to reveal)
|
| Method / Path: | POST /languages |
|---|---|
| Description: | Get information about languages in caption catalog (if such information is available). |
| Path params: | NONE |
| Required (form) params: | captions: Captions to be examined. |
| Optional (form) params: | input(Default value=dfxp): Caption input format (for example: dfxp, subrip,...). |
| Response formats: | text/xml |
| Status codes: | 200: OK, OK, information was extracted and retrieved |
| Notes: |
|
| Testing: |
Sample:
/languages
Testing form (click to reveal)
|