| Previous Article | matchIT Hub Index | Next Article |
Resources relative to http://host:8080/matchITHub/engines/<engine>
| REST resource | Summary |
|---|---|
| GET state | Gets the state of the engine |
| PUT ?state="pause" | Pause a running engine |
| PUT ?state="resume" | Resume a paused engine |
| PUT ?state="abort" | Abort |
| PUT ?state="reset" | Reset |
GET /matchITHub/engines/<engine>/state
Request
| Type | Name | Description |
|---|---|---|
| PathParam | engine | The id of the engine to query |
Response
| Name | Value |
|---|---|
| State | “uninitialized”, “initialized”, “ready”, “running”, “paused”, “finished”, “aborted” |
Description
Gets the state of the engine.
Usage Examples
Using a browser
Using cURL:
curl http://localhost:8080/matchITHub/engines/1/state
{"status":"OK","state":"Initialized:\nthe engine has been initialized but no settings applied"}
PUT /matchITHub/engines/<engine>?state=<state>
Request
| Type | Name | Description |
|---|---|---|
| PathParam | engine | The id of the engine to modify |
| QueryParam | state | The state to change the engine to: “pause”, “resume”, “abort”, “reset” |
Description
Changes the state of the engine. Equivalent to the hub methods: pause, resume, abort, reset.
Usage Example
Using cURL:
curl -X PUT http://localhost:8080/matchITHub/engines/1?state=pause
| Previous Article | matchIT Hub Index | Next Article |