Add a simulation group

Enables to add a simulations group associated to a scenario already registered in OOP.

See also → Creating a scenario.

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:

Request

POST 

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

Request parameters

Not applicable.

Request content-type

XML

Request body (payload)

XML message representing the simulations group to insert as defined in orca2.xsd (right-click to download).

Additional Notes

Here the attributes that you can specify in the payload, associated to the <simulationParameters> tag:

Traffic element (complexType) Attributes associated

SimulationsParameters

List of attributes:

Attribute

Description

assignmentType

Data type: String.

Required: YES.

  • DTA (Dynamic Traffic Assignment):It is necessary more than one iteration. You must select this option if it is necessary calculate a new equilibrium.
  • DNL (Dynamic Network Loading): It is necessary only one iteration.

numberOfIteration

Data type: Integer.

Required: YES.

Set the number of iterations for the simulations group.

warmStart

Data type: Boolean.

Required: NO (optional).

For future use, currently not effective.

scenarioEventsOnly

Data type: Boolean.

Required: NO (optional).

Possible values:

  • false: The simulation also hosts real events happening on the network (additionally to the ones defined in the simulations).
  • true: Default value. The simulation hosts only events defined in the simulation.

useTrafficState

Data type: Boolean.

Required: NO (optional).

Possible values:

  • true: Default value. The simulation hosts the real time feed (if there are traffic states available for the simulation interval).
  • false: Otherwise.

Important:  In some situations, the traffic state events could be prevalent on the events associated to the scenario.

startTime

endTime

Data type: String formatted as ISO 8601 with or without timezone.

Required: YES

The date and the time period for the simulations group.

Tip:  The dimension of the time interval can have a meaningful impact on the performance of the simulations. Greater is the interval (endTime-startTime), slower could be the calculation of the results.

Response status

HTTP status Description

200 OK

Result of the processed request.

400 Bad request

Several conditions can be classified under this code.

Generally, when an IllegalArgumentException occurs.

Main examples:

  • If the payload is not well formatted.

  • If the payload is null.

404 Not found

In case of a missing element necessary to create the simulations group.

Response content-type

Not applicable.

Response entity

Not applicable.

Request

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

Request body (payload)

<?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">
    <exchange>
        <provider>PTV-OPTIMA</provider>
    </exchange>
    <payloadPublication xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="SimulationPayload" publicationTime="2021-08-17T17:14:50">
        <MetaInfo>
            <timezone>Europe/Rome</timezone>
        </MetaInfo>
        <simulationGroup publicVisibility="false" description="Testing postman">
            <simulation description="AAA1">
                <scenario idno="6"/>
            </simulation>
            <simulation description="AAA2">
                <scenario idno="5"/>
            </simulation>
            <simulation description="AAA3">
                <scenario idno="5"/>
                <scenario idno="6"/>
            </simulation>
            <simulationParameters assignmentType="DNL" numberOfIteration="0" warmStart="false" scenarioEventsOnly="true" useTrafficstate="true" startTime="2021-08-17T17:14:50" endTime="2021-08-17T19:14:50"/>
        </simulationGroup>
    </payloadPublication>
</Orca2Model>

Response status

HTTP status Description

200 OK

Result of the processed request.