General Notes
- All paths above are relative to the REST endpoint base (something like http://your.server/termination/)
- 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 /state |
|---|---|
| Description: | Returns the Termination State as JSON. Possible termination states are none, wait and ready. |
| Path params: | NONE |
| Optional (query) params: | NONE |
| Response formats: | application/json |
| Status codes: |
200: OK, A JSON representation of the termination state. 503: Service Unavailable, The Termination State Service is disabled or unavailable |
| Notes: |
|
| Testing: |
Sample:
/state
/termination/state
|
Write methods
| Method / Path: | PUT /state |
|---|---|
| Description: | Set the termination state. The only permissable values are 'none', 'wait' or 'ready' |
| Path params: | NONE |
| Required (form) params: | state: The termination state, the only valid value is 'wait' |
| Optional (form) params: | NONE |
| Status codes: |
204: No Content, The node is preparing to terminate 400: Bad Request, The state was not valid 503: Service Unavailable, The Termination State Service is disabled or unavailable |
| Notes: |
|
| Testing: |
Sample:
/state
Testing form (click to reveal)
|