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 /providers.json |
|---|---|
| Description: | Returns active providers |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: | application/json |
| Status codes: | 200: OK, The active providers. |
| Notes: |
|
| Testing: |
Sample:
/providers.json
/statistics/providers.json
|
| Method / Path: | GET /timeseries/{providerId:.+}.json |
|---|---|
| Description: | Returns the time series data for the given providerId |
| Path params: | providerId: The provider identifier |
| Required (form) params: |
resourceId: The id of the resource to get the data for. E.g. episode id.
from: Start of the time series as ISO 8601 UTC date string to: End of the time series as ISO 8601 UTC date string resolution: Data aggregation level. Must be one of 'daily', 'weekly', 'monthly', 'yearly' zoneId: The time zone id to use for calculations |
| Optional (query) params: | NONE |
| Response formats: | application/json |
| Status codes: | 200: OK, The time series data. |
| Notes: |
|
| Testing: |
Sample:
/timeseries/{providerId:.+}.json
Testing form (click to reveal)
|
| Method / Path: | GET /writeDuration |
|---|---|
| Description: | Writes a duration |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: | application/json |
| Status codes: | 204: No Content, Writing worked |
| Testing: |
Sample:
/writeDuration
/statistics/writeDuration
|