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
- GET /job/{jobID}.{format:xml|json}
- GET /job/{jobID}/{filename}
- DELETE /job/{jobID}
- POST /job/{jobID}
- POST /newjob
Read methods
| Method / Path: | GET /job/{jobID}.{format:xml|json} |
|---|---|
| Description: | Returns the XML or the JSON representation of an upload job. |
| Path params: |
jobID:
The ID of the upload job format: The output format (json or xml) of the response body. |
| Optional (query) params: | NONE |
| Response formats: |
application/xml
application/json |
| Status codes: |
200: OK, the job was successfully retrieved. 404: Not Found, the job was not found. |
| Notes: |
|
| Testing: |
Sample:
/job/{jobID}.{format:xml|json}
Testing form (click to reveal)
|
| Method / Path: | GET /job/{jobID}/{filename} |
|---|---|
| Description: | Returns the payload of the upload job. |
| Path params: |
jobID:
The ID of the upload job to retrieve the file from filename: The name of the payload file |
| Optional (query) params: | NONE |
| Response formats: | application/octet-stream |
| Status codes: |
200: OK, the job and file have been found. 404: Not Found, the job or file were not found. |
| Notes: |
|
| Testing: |
Sample:
/job/{jobID}/{filename}
Testing form (click to reveal)
|
Write methods
| Method / Path: | DELETE /job/{jobID} |
|---|---|
| Description: | Deletes an upload job on the server. |
| Path params: | jobID: The ID of the upload job to be deleted |
| Optional (query) params: | NONE |
| Response formats: | text/plain |
| Status codes: |
200: OK, the job was successfully deleted. 404: Not Found, the job was not found. |
| Notes: |
|
| Testing: |
Sample:
/job/{jobID}
Testing form (click to reveal)
|
| Method / Path: | POST /job/{jobID} |
|---|---|
| Description: | Appends the next chunk of data to the file on the server. |
| Path params: | jobID: The ID of the upload job |
| Optional (form) params: |
chunknumber:
The number of the current chunk filedata: The payload |
| Response formats: | application/xml |
| Status codes: |
200: OK, the chunk data was successfully appended to file on server 404: Not Found, the upload job was not found 400: Bad Request, the request was malformed |
| Notes: |
|
| Testing: |
Sample:
/job/{jobID}
Testing form (click to reveal)
|
| Method / Path: | POST /newjob |
|---|---|
| Description: | Creates a new upload job and returns the jobs ID. |
| Path params: | NONE |
| Optional (form) params: |
filename:
The name of the file that will be uploaded filesize: The size of the file that will be uploaded chunksize: The size of the chunks that will be uploaded flavor: The flavor of this track mediapackage: The mediapackage the file should belong to |
| Response formats: | text/plain |
| Status codes: |
200: OK, job was successfully created 204: No Content, upload service gave an error |
| Notes: |
|
| Testing: |
Sample:
/newjob
Testing form (click to reveal)
|