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 /publishToStreaming |
|---|---|
| Description: | Checks whether publish to streaming is configured for the current organization |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: | application/json |
| Status codes: | 200: OK, Whether publish to streaming is configured for the current organization. |
| Notes: |
|
| Testing: |
Sample:
/publishToStreaming
/distribution/streaming/publishToStreaming
|
Write methods
| Method / Path: | POST / |
|---|---|
| Description: | Distribute a media package element to this distribution channel |
| Path params: | NONE |
| Required (form) params: |
mediapackage: The mediapackage
channelId: The publication channel ID elementIds: The elements to distribute as Json Array['IdOne','IdTwo'] |
| Optional (form) params: | NONE |
| Response formats: | text/xml |
| Status codes: |
200: OK, An XML representation of the distribution job 204: No Content, There is no streaming distribution service available |
| Notes: |
|
| Testing: |
Sample:
/
Testing form (click to reveal)
|
| Method / Path: | POST /distributesync |
|---|---|
| Description: | Syncrhonously distribute a media package element to this distribution channel |
| Path params: | NONE |
| Required (form) params: |
mediapackage: The mediapackage
channelId: The publication channel ID elementIds: The elements to distribute as Json Array['IdOne','IdTwo'] |
| Optional (form) params: | NONE |
| Response formats: | text/xml |
| Status codes: |
200: OK, An XML representation of the distribution 204: No Content, There is no streaming distribution service available |
| Notes: |
|
| Testing: |
Sample:
/distributesync
Testing form (click to reveal)
|
| Method / Path: | POST /retract |
|---|---|
| Description: | Retract a media package element from this distribution channel |
| Path params: | NONE |
| Required (form) params: |
mediapackage: The mediapackage
channelId: The publication channel ID elementIds: The elements to retract as Json Array['IdOne','IdTwo'] |
| Optional (form) params: | NONE |
| Response formats: | text/xml |
| Status codes: |
200: OK, An XML representation of the retraction job 204: No Content, There is no streaming distribution service available |
| Notes: |
|
| Testing: |
Sample:
/retract
Testing form (click to reveal)
|
| Method / Path: | POST /retractsync |
|---|---|
| Description: | Synchronously retract a media package element from this distribution channel |
| Path params: | NONE |
| Required (form) params: |
mediapackage: The mediapackage
channelId: The publication channel ID elementIds: The elements to retract as Json Array['IdOne','IdTwo'] |
| Optional (form) params: | NONE |
| Response formats: | text/xml |
| Status codes: |
200: OK, An XML representation of the retraction 204: No Content, There is no streaming distribution service available |
| Notes: |
|
| Testing: |
Sample:
/retractsync
Testing form (click to reveal)
|