Add a simulation group

It enables adding a simulation group associated to a scenario that is already registered on 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)

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

Additional Notes

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

Traffic element (complexType) Attributes associated

SimulationsParameters

List of attributes:

Attribute

Description

assignmentType

Data type: String.

Required: YES.

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

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, traffic state events may prevail over the events associated to the scenario.

startTime

endTime

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

Required: YES

It refers to the date and time period applied to the simulation group.

Tip:  The duration of the time interval may have a meaningful impact on the performance of the simulations. The greater is the interval (endTime-startTime), the the calculation of the results may be.

Response status

HTTP status Description

200 OK

Result of the processed request.

400 Bad request

Several conditions can be classified under this code.

It generally appears when an IllegalArgumentException occurs.

Main examples:

  • If the payload is not well formatted.

  • If the payload is null.

404 Not found

It appears when there is 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.