Getting a list of all simulation groups

Request

GET optima-as/datex-interface/simulation/group

Request resource

Not applicable

Request parameters

Parameter Required Description

status

NO

Integer value to filter simulation groups.

The possible values are:

  • 0: READY, returns the simulation groups that are ready to be loaded by TRE for processing.
  • 1: COMPLETED, returns the simulation groups that have completed the run process.
  • 2: IN_PROGRESS, returns the simulation groups currently running.
  • 3: ALL, returns all the simulation groups registered in Optima.

If the query parameter is not specified, you get ALL simulation groups with status values different from 1.

If the query parameter is specified, you get ALL simulation groups with status value = X.

Request content-type

application/xml

Request body (payload)

N/A

Response status

HTTP status Description

200 OK

Result of the processed request.

Response content-type

application/xml

Response entity

XML message that contains all simulation groups in Optima as defined in orca2.xsd (right-click to download).

Request

https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/simulation/group?status=0

Response status

HTTP status Description

200 OK

Result of the processed request.

Response output

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Orca2Model xmlns="http://sistemaits.com/orca2/1" xmlns:ns2="http://datex2.eu/schema/2/2_0" xmlns:ns3="http://datex2.eu/schema/2/2_0/com/sistemaits/ext">
    <exchange>
        <provider>PTV-OPTIMA</provider>
    </exchange>
    <payloadPublication xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimulationPayload" publicationTime="2016-03-18T12:28:17.371">
        <MetaInfo>
            <timezone>Europe/Rome</timezone>
        </MetaInfo>
        <simulationGroup idno="6" description="Testing a road closure" status="0">
            <simulation idno="153101" description="Case0 no scenario" base="false" simulationGroup="6"/>
            <simulation idno="153102" description="Case1 road closed" base="false" simulationGroup="6">
                <scenario idno="1"/>
            </simulation>
        </simulationGroup>
    </payloadPublication>
</Orca2Model>