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 /{uuid} |
|---|---|
| Description: | Returns a static file resource |
| Path params: | uuid: Static File Universal Unique Id |
| Optional (query) params: | NONE |
| Status codes: |
200: OK, Returns a static file resource 404: Not Found, No file by the given uuid found |
| Testing: |
Sample:
/{uuid}
Testing form (click to reveal)
|
| Method / Path: | GET /{uuid}/url |
|---|---|
| Description: | Returns a static file resource's URL |
| Path params: | uuid: Static File Universal Unique Id |
| Optional (query) params: | NONE |
| Response formats: | text/plain |
| Status codes: |
200: OK, Returns a static file resource's URL 404: Not Found, No file by the given uuid found |
| Testing: |
Sample:
/{uuid}/url
Testing form (click to reveal)
|
Write methods
| Method / Path: | DELETE /{uuid} |
|---|---|
| Description: | Remove the static file |
| Path params: | uuid: Static File Universal Unique Id |
| Optional (query) params: | NONE |
| Status codes: |
204: No Content, File deleted 404: Not Found, No file by the given uuid found |
| Notes: |
|
| Testing: |
Sample:
/{uuid}
Testing form (click to reveal)
|
| Method / Path: | POST /{uuid}/persist |
|---|---|
| Description: | Persists a recently uploaded file to the permanent storage |
| Path params: | uuid: File UUID |
| Optional (form) params: | NONE |
| Status codes: |
200: OK, The file has been persisted 404: Not Found, No file by the given UUID found |
| Testing: |
Sample:
/{uuid}/persist
Testing form (click to reveal)
|
| Method / Path: | POST / |
|---|---|
| Description: | Post a new static resource |
| Path params: | NONE |
| Body (upload) param: | The static resource file |
| Optional (form) params: | NONE |
| Response formats: | text/plain |
| Status codes: |
201: Created, Returns the id of the uploaded static resource 400: Bad Request, No filename or file to upload found 400: Bad Request, The upload size is too big |
| Testing: |
Sample:
/
Testing form (click to reveal)
|