Getting simulation groups

It returns all simulation groups that are associated to a specific value which identifies the current state of all the relevant simulation groups.

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

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

Request

GET

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

Request parameters

Parameter	Required	Description
stat	YES	Identifier of the state of the simulation group. Possible values: 0: PENDING 1: DONE 2: IN PROGRESS 3: ERROR

Parameter

Required

Description

stat

YES

Identifier of the state of the simulation group.

Possible values:

0: PENDING
1: DONE
2: IN PROGRESS
3: ERROR

Request content-type

Not applicable.

Request body (payload)

Not applicable.

Response

Response status

HTTP status	Description
200 OK	Result of the processed request. It may also return an empty list of simulation groups.
400 Bad Request	The mandatory query parameter status is missing.

Response content-type

XML

Response output

An XML message as defined in orca2.xsd (right-click to download).

Example

Request

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

Response status

HTTP status	Description
200 OK	Result of the processed request.

Response output

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:Orca2Model xmlns="http://datex2.eu/schema/2/2_0" xmlns:ns2="http://sistemaits.com/orca2/1">
    <ns2:exchange>
        <ns2:provider>PTV-OPTIMA</ns2:provider>
    </ns2:exchange>
    <ns2:payloadPublication xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="ns2:SimulationPayload" publicationTime="2019-03-11T14:26:16.26">
        <ns2:MetaInfo>
            <ns2:timezone>Europe/Rome</ns2:timezone>
        </ns2:MetaInfo>
        <ns2:simulationGroup idno="42" publicVisibility="false" description="AAAA   Testing optima planning" status="1">
            <ns2:simulationParameters assignmentType="DTA" numberOfIteration="5" warmStart="false" scenarioEventsOnly="true" useTrafficstate="true" startTime="2019-03-08T00:00:00" endTime="2019-03-08T04:00:00"/>
        </ns2:simulationGroup>
        <ns2:simulationGroup idno="43" publicVisibility="false" description="AAAA   Testing optima planning" status="1">
            <ns2:simulationParameters assignmentType="DTA" numberOfIteration="5" warmStart="false" scenarioEventsOnly="true" useTrafficstate="true" startTime="2019-03-08T00:00:00" endTime="2019-03-08T04:00:00"/>
        </ns2:simulationGroup>
        <ns2:simulationGroup idno="47" publicVisibility="false" description="AAAA   Testing optima planning" status="1">
            <ns2:simulationParameters assignmentType="DTA" numberOfIteration="5" warmStart="false" scenarioEventsOnly="true" useTrafficstate="true" startTime="2019-03-08T00:00:00" endTime="2019-03-08T04:00:00"/>
        </ns2:simulationGroup>
        <ns2:simulationGroup idno="50" publicVisibility="false" description="AAAA   Testing optima planning" status="1">
            <ns2:simulationParameters assignmentType="DNL" numberOfIteration="0" warmStart="false" scenarioEventsOnly="true" useTrafficstate="true" startTime="2019-03-08T00:00:00" endTime="2019-03-08T04:00:00"/>
        </ns2:simulationGroup>
        <ns2:simulationGroup idno="44" publicVisibility="false" description="AAAA   Testing optima planning" status="1">
            <ns2:simulationParameters assignmentType="DTA" numberOfIteration="5" warmStart="false" scenarioEventsOnly="true" useTrafficstate="true" startTime="2019-03-08T00:00:00" endTime="2019-03-08T04:00:00"/>
        </ns2:simulationGroup>
        <ns2:simulationGroup idno="39" publicVisibility="false" description="AAAA   Testing optima planning" status="1">
            <ns2:simulationParameters assignmentType="DTA" numberOfIteration="1" warmStart="false" scenarioEventsOnly="true" useTrafficstate="true" startTime="2019-03-08T00:00:00" endTime="2019-03-08T00:15:00"/>
        </ns2:simulationGroup>
        <ns2:simulationGroup idno="45" publicVisibility="false" description="AAAA   Testing optima planning" status="1">
            <ns2:simulationParameters assignmentType="DTA" numberOfIteration="5" warmStart="false" scenarioEventsOnly="true" useTrafficstate="true" startTime="2019-03-08T00:00:00" endTime="2019-03-08T04:00:00"/>
        </ns2:simulationGroup>
        <ns2:simulationGroup idno="49" publicVisibility="false" description="AAAA   Testing optima planning" status="1">
            <ns2:simulationParameters assignmentType="DNL" numberOfIteration="0" warmStart="false" scenarioEventsOnly="true" useTrafficstate="true" startTime="2019-03-08T00:00:00" endTime="2019-03-08T04:00:00"/>
        </ns2:simulationGroup>
        <ns2:simulationGroup idno="52" publicVisibility="false" description="AAAA   Testing optima planning" status="1">
            <ns2:simulationParameters assignmentType="DNL" numberOfIteration="0" warmStart="false" scenarioEventsOnly="true" useTrafficstate="true" startTime="2019-03-08T00:00:00" endTime="2019-03-08T04:00:00"/>
        </ns2:simulationGroup>
        <ns2:simulationGroup idno="51" publicVisibility="false" description="AAAA   Testing optima planning" status="1">
            <ns2:simulationParameters assignmentType="DNL" numberOfIteration="0" warmStart="false" scenarioEventsOnly="true" useTrafficstate="true" startTime="2019-03-08T00:00:00" endTime="2019-03-08T04:00:00"/>
        </ns2:simulationGroup>
    </ns2:payloadPublication>
</ns2:Orca2Model>