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
- Important: This service is for exclusive use by the module admin-ui. Its API might change anytime without prior notice. Any dependencies other than the admin UI will be strictly ignored. DO NOT use this for integration of third-party applications.
Table of Contents
Read methods
| Method / Path: | GET /processing.json |
|---|---|
| Description: | Returns all the data related to the processing tab in the new tasks modal as JSON |
| Path params: | NONE |
| Optional (query) params: | tags: A comma separated list of tags to filter the workflow definitions |
| Status codes: | 200: OK, Returns all the data related to the tasks processing tab as JSON |
| Notes: |
|
| Testing: |
Sample:
/processing.json?tags={tags}
Testing form (click to reveal)
|
Write methods
| Method / Path: | POST /new |
|---|---|
| Description: | Creates a new task by the given metadata as JSON |
| Path params: | NONE |
| Required (form) params: |
metadata: The metadata as JSON. Example:
|
| Optional (form) params: | NONE |
| Status codes: |
201: Created, Task sucessfully added 404: Not Found, If the workflow definition is not found 400: Bad Request, If the metadata is not set or couldn't be parsed |
| Notes: |
|
| Testing: |
Sample:
/new
Testing form (click to reveal)
|