It returns the status of an Optima Operational Planning simulation.
The response provides an XML file with a main element named simulationStatusResponse. It contains two properties:
-
id: that is the unique identifier of the simulation
-
simulationStatus: that has the same meaning it has in Short Term Forecast.
The set of the possible statuses of the OOP simulation is listed in the table:
| Status | Description |
|---|---|
|
PENDING |
The request is in the queue, waiting to be run. |
|
DONE_SIMULATION |
The simulation has been completed. |
|
RUNNING_SIMULATION |
The simulation is currently running. |
|
RUNNING_KPI |
The KPI associated to the simulation is being calculated. |
|
DONE_KPI |
The process is completed and the associated KPIs have been correctly computed. |
|
ERROR_KPI |
An error came up during the KPI calculation. |
|
FAILED |
The request has failed. |
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
Request
GET
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/simulation/group/simulationStatus/{idno}
The path parameter idno must be specified. It must be a valid simulation identifier.
Request parameters
Not applicable.
Request content-type
Not applicable
Request body (payload)
Not applicable
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
|
400 Bad request |
The path parameter idno is null. |
|
404 Not found |
If the simulations associated to the path parameter idno is not present. |
Response content-type
application/xml
Response entity
An XML message.
Example
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/simulation/group/simulationStatus/135
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
Response output
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<simulationStatusResponse>
<id>135</id>
<simulationStatus>PENDING</simulationStatus>
</simulationStatusResponse>