Getting the status of a simulations group

It returns the status of the simulation group associated to an Optima Planning simulation.

The response provides an XML file according to orca2.xsd (see ORCA2.xsd).

In the response, you can detect:

The identifier of all simulations in the group and the associated status.
The status of the simulation group.

For more details, see → Optima Operational Planning: response status.

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 node).
An explicit Logout call (→ Logout).

Request

GET

https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/simulation/group/simulationGroupStatus/{idno}

The path parameter idno must be specified. It must be a valid simulation group 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.
204 No Content	The path parameter idno is null.
404 Not found	When the simulation group associated to the path parameter idno is not present.

Response content-type

application/xml

Response entity

An XML message that contains all information for the specified simulation group as defined in orca2.xsd (right-click to download).

Example 1

Request

https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/simulation/group/simulationGroupStatus/52

Response status

HTTP status	Description
200 OK	Result of the processed request.

Response output

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<simulationGroupStatusResponse>
    <id>52</id>
    <status>IN_PROCESS</status>
    <simulationStatusResponses>
        <id>129</id>
        <simulationStatus>PENDING</simulationStatus>
    </simulationStatusResponses>
    <simulationStatusResponses>
        <id>134</id>
        <simulationStatus>RUNNING_SIMULATION</simulationStatus>
    </simulationStatusResponses>
</simulationGroupStatusResponse>

Example 2

Request

https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/simulation/group/simulationGroupStatus/12

Response status

HTTP status	Description
200 OK	Result of the processed request.

Response output

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<simulationGroupStatusResponse>
    <id>12</id>
    <status>DONE</status>
    <simulationStatusResponses>
        <id>4220</id>
        <simulationStatus>DONE_KPI</simulationStatus>
    </simulationStatusResponses>
    <simulationStatusResponses>
        <id>4221</id>
        <simulationStatus>DONE_KPI</simulationStatus>
    </simulationStatusResponses>
    <simulationStatusResponses>
        <id>4223</id>
        <simulationStatus>DONE_KPI</simulationStatus>
    </simulationStatusResponses>
    <simulationStatusResponses>
        <id>4222</id>
        <simulationStatus>DONE_KPI</simulationStatus>
    </simulationStatusResponses>
    <simulationStatusResponses>
        <id>4224</id>
        <simulationStatus>DONE_KPI</simulationStatus>
    </simulationStatusResponses>
</simulationGroupStatusResponse>