REST interface

Global Endpoints

• Heartbeat: GET /rest/ping
• Get State: GET /rest/state
• Clear Simulation Data: GET /rest/clear
• Prepare Simulation: GET /rest/prepare

Simulation specific endpoints

In the following {id} stands for the ID of the prepared simulation. This ID is obtained by calling the end point for "Prepare Simulation".

---

• Get State: GET /rest/{id}/state
• Clear Simulation Data: GET /rest/{id}/clear
• Get Simulation Results: GET /rest/{id}/results
• Start Simulation: GET /rest/{id}/start
  

---

• Add Model to the Simulation: POST /rest/{id}/set/{type}
• Set Simulation Configuration: POST /rest/{id}/set/config

Common Request Order

1. Heartbeat
2. Prepare Simulation
3. Add Model to the Simulation
4. Set Simulation Configuration
5. Start Simulation
6. Get State (until Simulation is marked as "finished")
7. Get Simulation Results