Creating a simulation group

Returns the creation of a simulation group.

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>/datex-interface/simulation/group

Request parameters

Not applicable.

Request content-type

application/xml

Request body (payload)

XML message describing a simulation group as defined in orca2.xsd (right-click to download).

Additional Notes

Here the attributes that you can specify in the payload:

Traffic element (complexType) Attributes

SimulationGroup

List of attributes:

Attribute

Description

idno

Data type: Integer.

Required: NO (optional).

Identifier of the simulation group.

user

Data type: String

Required: NO (optional)

User associated to the simulation group.

publicVisibility

Data type: Boolean

Required: NO (optional)

Possible values:

  • true: Default value. The simulation group is visible ?????.
  • false: Otherwise.

description

Data type: String

Required: NO (optional)

Description associated to the simulation group.

 

status

Data type: Integer

Required: NO (optional)

Possible values:

  • 0: Default value. Ready for simulation.
  • 1: Completed.
  • 2: In process.
  • NULL: Not ready to be simulated.

timestamp

NOT USED.

 

Traffic element (complexType) Attributes

Simulation

List of attributes:

Attribute

Description

idno

Data type: String

Required: NO (optional)

Description associated to the simulation.

description

Data type: String

Required: NO (optional)

Description associated to the simulation.

base

Data type: boolean

Required: NO

  • true: indicates the base simulation automatically generated by STF engine

  • false: indicates a no-base simulation

Default value: false

If you specify it, the value must be set to false.

Important:  In the API response, you get this attribute set to false anyhow, even if it is not specified in the API request.

inst

Data type: boolean

Required: NO

  • true: indicates the base simulation automatically generated by STF engine

  • false: indicates a no-base simulation

Default value: false

If you specify it, the value must be set to false.

Important:  In the API response, you get this attribute set to false anyhow, even if it is not specified in the API request.

Required: NO (optional).

Ending instant of the run.

If inst=NULL, the simulation is not yet run.

dayType

Data type: Integer.

Required: NO (optional).

Identifier of the day type.

simulationStart

Data type: dateTime.

Required: NO (optional).

Computation start instant of the simulation.

simulationPeriodStart

Data type: dateTime.

Required: NO (optional).

Computation start instant of the simulated horizon.

simulationPeriodEnd

Data type: dateTime.

Required: NO (optional).

Computation end instant of the simulated horizon.

applicationName

Data type: String

Required: NO (optional)

Name of the application launched by the simulation.

simulationGroup

Data type: Integer

Required: NO (optional)

Identifier of the simulation group associated to the simulation.

If simulationGroup=NULL, the simulation group hosts a single simulation.

status

Data type: Integer

Required: NO (optional)

Possible values:

  • 0: Pending.
  • 1: Completed.
  • 2: In process.
  • 3: Running KPIs
  • 4: KPI completed
  • 5: KPI error
  • 6: Cancelled
  • NULL: Not ready to be simulated.

The attributes status and idno, for both objects Simulation and SimulationGroup,can be considered only output parameters because their input values are ignored.

Response status

HTTP status Description

200 OK

Result of the processed request.

Response content-type

application/xml

Response entity

The response entity is equal to the request entity plus the idno of the created simulation group.

Request

https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/simulation/group

Request input

<?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-09T09:53:38.24">
		<MetaInfo>
			<timezone>Europe/Rome</timezone>
		</MetaInfo>
		<simulationGroup status="0" description="Testing a road closure">
			<simulation description="Case0 no scenario" base="false" />
			<simulation description="Case1 road closed" base="false">
				<scenario idno="1" />
			</simulation>
		</simulationGroup>		
	</payloadPublication>
</Orca2Model>

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-31T10:08:23.822">
        <MetaInfo>
            <timezone>Europe/Rome</timezone>
        </MetaInfo>
        <simulationGroup idno="7" description="Testing a road closure" status="0">
            <simulation idno="156767" description="Case0 no scenario" base="false" simulationGroup="7"/>
            <simulation idno="156768" description="Case1 road closed" base="false" simulationGroup="7">
                <scenario idno="1"/>
            </simulation>
        </simulationGroup>
    </payloadPublication>
</Orca2Model>