List of API endpoints

The following list provides a summary of all API endpoints.

Authentication

Endpoint (click to go to description)	Purpose
Authentication	Authentication

Traffic states

Endpoint (click to go to description)	Purpose
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/orca2/trafficstate	Pushing traffic states with ORCAv2
POST <vehicletracker_hostname>[:port]/fcd/	Pushing GPS, ANPR, or Bluetooth data with Vehicle Tracker
POST <vehicletracker_hostname>[:port]/portal/	Pushing GPS, ANPR, or Bluetooth data with Vehicle Tracker
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/orca2/trafficstate/{location}/	Getting harmonized traffic states

Traffic events

Endpoint (click to go to description)	Purpose
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex2import/optima/situationPublication	Getting all traffic events
https://<HOST_IP_ADDRESS>:<PORT_NUMBER>/datex2import/optima/event/get	Getting a single traffic event
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex2import/optima/event/preview	Getting a single traffic event description
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex2import/optima/	Pushing DATEX II events
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex2import/optima/event/delete	Deleting traffic events

Traffic forecast

Endpoint (click to go to description)	Purpose
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/orca2/rlin/{location}	Getting traffic forecast

Smart display

Endpoint (click to go to description)	Purpose
GET <vms_hostname>[:port]/vms/	Optima Smart Display API
GET WILDFLY_HOST/datex-interface/vms/optima	S.I.MO.NE. VMS API

Key Performance Indicators (KPI) (DEPRECATED)

Endpoint (click to go to description)	Purpose
GET optima-as/geoserver/wfs/	Getting a list of available KPIs
GET optima-as/geoserver/wfs/	Getting the values of a specific KPI

Key Performance Indicators (KPI)

Endpoint (click to go to description)	Purpose
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-kpi/kpi/api/instance	Create a KPI instance
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-kpi/kpi/api/instance/<instance_id>	Delete a KPI instance
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-kpi/kpi/api/instances/?providerId=<providerId>	Getting a list of KPI instances
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-kpi/kpi/api/instance/<instance_id>	Getting a single KPI instance
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-kpi/kpi/api/instance	Update a KPI instance
Getting KPI results based on KPI ID	Returns results associated to a KPI instance identified by a KPI ID.
Getting KPI results based on Provider ID	Returns results, associated to a specific Provider ID.
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-kpi/kpi/api/results/bySimulationGroupId/<simg_id>	Returns results associated to a specific Simulation Group ID.

Scenario

Endpoint (click to go to description)	Purpose
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/scenario	Getting a list of all scenarios
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/scenario/{idno}	Getting the details of a scenario
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/scenario	Creating a scenario
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/scenario/{idno}	Deleting a scenario
GET optima-as/datex-interface/simulation/group	Getting a list of all simulation groups
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/simulation/group/{idno}	Getting the details of a simulation group
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/simulation/group	Creating a simulation group
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/simulation/group/{idno}	Deleting a simulation group

Simulation engine

Endpoint (click to go to description)	Purpose
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/simulation/engine/{appname}	Getting the status of a simulation engine
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex-interface/simulation/engine/{appname}/start	Starting a simulation

Simulation engines – Optima Micro

Endpoint (click to go to description)	Purpose
POST optima-as/optimissim/simulations	Requesting a micro simulation or micro simulation group
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optimissim/simulations/	Getting a list of micro simulations and micro simulation groups
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optimissim/simulations/{MicroSimulationGroupId}	Getting status, configuration or KPI results of a simulation group
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optimissim/simulation/{MicroSimulationId}	Getting status, configuration or KPI results of a single simulation
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optimissim/subnetwork/{SubnetworkId}	Getting information about micro simulation subnetworks
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optimissim/subnetwork/{SubnetworkId}/controller	Getting information about signal controllers of a subnetwork
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optimissim/simulation/{MicroSimulationId}/vissim-data	Getting a micro simulation package for offline usage in PTV Vissim

Simulation engines – Optima Planning

Endpoint (click to go to description)	Purpose
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/simulation/group	Add a simulation group
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/simulation/group/{idno}	Delete a simulation group
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/simulation/group	Getting simulations groups
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/simulation/group/simulationGroupStatus/{idno}	Getting the status of a simulations group
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/simulation/group/simulationStatus/{idno}	Getting the status of a simulation
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-planning/results/strt	Getting forecast results

Public transport

Endpoint (click to go to description)	Purpose
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/eta/trip/{tripId}	Getting the ETA Estimated Time of Arrival for trips
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/eta/vehicle/{vehicleId}	Getting the ETA Estimated Time of Arrival for vehicles
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/eta/stop/{public_stop_id}	Getting the ETA Estimated Time of Arrival for stops
GET https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/disruption/trip/{tripId}	Getting information on disruptions of a trip
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/disruption/stop/{public_stop_id}	Getting information on disrupted trips at a stop
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/event/line	Disabling a line
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/event/trip	Disabling a trip
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/event/trip/stops	Disabling stops of a trip
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/event/	Getting PuT events
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/event/	Deleting PuT events
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/topology/line/stop/{public_stop_id}	Getting the lines that pass a stop
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/topology/line_route/stop/{public_stop_id}	Getting the line routes that pass a stop
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/transfer/trip/{from_public_stop_id}/{from_trip _id}/{to_public_stop_id}/{to_trip _id}/	Getting the trip-trip-transfer time
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/transfer/triproute/{from_public_stop_id}/{from_trip _id}/{to_public_stop_id}/{to_route_id}/	Getting the trip-route transfer time
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/transfer/route/{from_public_stop_id}/{from_route _id}/{to_public_stop_id}/{to_route_id}/	Getting the route-route transfer time
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/transfer/predefined	Getting the time for transfers
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/transfer/predefined/	Creating transfers
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/transfer/predefined/	Deleting transfers
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/position/vehicle/	Getting expected positions of vehicles by time
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/position/vehicle/	Acquiring positions of vehicles by time (PUSH mode)
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/position/trip/	Getting expected positions of vehicles by trips and time
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/position/line	Getting expected positions of vehicles based on lines and time
Request endpoint	Getting vehicle raw positions from a GTFS feed

Pollution dispersions API

Endpoint (click to go to description)	Purpose
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/dispersions	Posting dispersions information for the heatmap