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 /generate |
---|---|
Description: | Generates a cover image based on the given metadata |
Path params: | NONE |
Required (form) params: |
xsl: XSLT stylesheet
width: Width of the cover image height: Height of the cover image targetflavor: Flavor of target cover image |
Optional (form) params: |
xml:
Metadata XML posterimage: URI of poster image |
Response formats: | text/xml |
Status codes: |
200: OK, Results in an xml document containing the job for the cover image generation task 400: Bad Request, If required parameters aren't set or not valid |
Testing: |
Sample:
/generate
Testing form (click to reveal)
|