Returns the current status, progress and configuration of a micro simulation group.
A micro simulation group can consist of several micro simulations with, for example, different traffic management actions.
When the run ends, the endpoint 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/simulations/{MicroSimulationGroupId}
The path parameter MicroSimulationGroupId must be specified and valid as obtained from → Requesting a micro simulation or micro simulation group.
Request parameters
Not applicable.
Request content-type
Not applicable.
Request body (payload)
Not applicable.
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
If the MicroSimulationGroupId is valid. |
|
404 Not Found |
If the simulation for the MicroSimulationGroupId 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 entity
JSON message with the description, status and KPI results of the simulations of the simulation group.
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/simulations/64278436-e644-4dcf-ae47-bc821742e824
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
Response output
{"microSimulationGroupId": "64278436-e644-4dcf-ae47-bc821742e824",
"subnetId": 2,
"description": null,
"microSimulations": [
{
"microSimulationId": "074a6832-c303-4d1f-8b16-6bdcd1500ef2",
"description": null,
"simulationPeriod": 3600,
"activeScenarioIds": [
1,
2
]
"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
}
},
{
"microSimulationId": "a75b5cfe-82a2-4aff-95dc-f14f2650dad9",
"description": null,
"simulationPeriod": 3600,
"activeScenarioIds": [
3,
4]
]
"status": "FINISHED",
"progress": 1,
"kpis": {
"StopsAvgMax": 10.152994350282485,
"DelayAvgMax": 459.0595103681386,
"StopsAvgStD": 0.07596075507048303,
"SpeedAvgMin": 3.6180748280312205,
"SpeedAvgAvg": 3.6640686219746685,
"DelayAvgStD": 6.874170747090658,
"DelayTotStD": 4449.87813584014,
"StopsTotStD": 904.3895731375943,
"DelayTotMax": 1994613.5725495622,
"StopsTotMax": 44927,
"StopsAvgMin": 10.045569620253165,
"StopsAvgAvg": 10.099281985267826,
"DelayAvgMin": 449.33796486754,
"DelayAvgAvg": 454.1987376178393,
"StopsTotMin": 43648,
"StopsTotAvg": 44287.5,
"DelayTotAvg": 1991467.0335442135,
"DelayTotMin": 1988320.4945388646,
"SpeedAvgStD": 0.06504504717984831,
"SpeedAvgMax": 3.710062415918117
},
"reliability": {
"numRunsWithKPIs": 2,
"numExpectedSimulationRuns": 2,
"numWarnings": 0,
"numErrors": 0,
"reliabilityIndex": 0.2
}
}
]
}