Returns the current status, progress and configuration of a single micro simulation. When the run ends, you get the resulting micro KPIs and the reliability of the results.
For more details, see → Optima Micro KPI results.
Authentication phase
Before using the endpoint, you must run the authentication phase (→ Login).
After the authentication, a session opens and a valid session token persists until:
- The end of the session time-out, that is set through the parameter sessionTimeout (→ OptimaWSI configuration > OptimaAuth section).
- An explicit Logout call (→ Logout).
Request Endpoint
Request
GET
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optimissim/simulation/{MicroSimulationId}The path parameter MicroSimulationId must be specified and valid as obtained from → Requesting a micro simulation or micro simulation group.
Request parameters
Not applicable.
Request content-type
Not appllicable.
Request body (payload)
Not applicable.
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
If the MicroSimulationId is valid. |
|
404 Not found. |
If the simulation for the MicroSimulationId was not found, the service answers with 404 and with a proper message in the entity. |
For the complete list of error codes and messages, see → Optima Micro: error codes and response status > Error codes of the Optima Micro API.
Response content-type
application/json
Response output
JSON message with the description, statuses and KPI results of the simulation.
For the complete list of the possible response statuses, see → Optima Micro: error codes and response status > Response Status.
Example
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optimissim/simulation/e37cb170-fd10-4065-9c4b-d361a2f1b614
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
Response output
{"microSimulationId": "074a6832-c303-4d1f-8b16-6bdcd1500ef2",
"subnetId": 2,
"description": null,
"simulationPeriod": 3600,
"status": "FINISHED",
"progress": 1,
"kpis": {
"StopsAvgMax": 9.925441615049323,
"DelayAvgMax": 463.62265760952914,
"StopsAvgStD": 0.1637737399140958,
"SpeedAvgMin": 3.5523755970772184,
"SpeedAvgAvg": 3.5807243393970154,
"DelayAvgStD": 2.7579273980121335,
"DelayTotStD": 16897.897493538905,
"StopsTotStD": 816.7083322704624,
"DelayTotMax": 2020931.1645199375,
"StopsTotMax": 43265,
"StopsAvgMin": 9.693830570902394,
"StopsAvgAvg": 9.809636092975857,
"DelayAvgMin": 459.72235927923117,
"DelayAvgAvg": 461.6725084443801,
"StopsTotMin": 42110,
"StopsTotAvg": 42687.5,
"DelayTotAvg": 2008982.5466144588,
"DelayTotMin": 1997033.92870898,
"SpeedAvgStD": 0.04009117586484386,
"SpeedAvgMax": 3.6090730817168124
},
"reliability": {
"numRunsWithKPIs": 2,
"numExpectedSimulationRuns": 2,
"numWarnings": 0,
"numErrors": 0,
"reliabilityIndex": 0.2
}
}