Error codes of the Optima Micro API
The PTV Optima Micro API handles error codes and error messages.
These error codes are used when the HTTP status of the response is not 200.
In this case, the response content-type is an application/JSON and has the following structure:
{
"errors": [
{
"code": "OPTMICRO-003",
"message": "No scenario simulations found"
}
]
}
| Error Code | Error Message | HTTP Code | Resource |
|---|---|---|---|
|
OPTMICRO-001 |
"No scenario group having at least one simulation request has been found through its associated UUID." + other dynamic information. |
404 |
optima-as/optimissim/simulations |
|
OPTMICRO-002 |
"One or more of the statuses specified in the query parameters don’t exist." + other dynamic information. |
400 |
optima-as/optimissim/simulations |
|
OPTMICRO-003 |
"No scenario simulations found." |
404 |
optima-as/optimissim/simulations |
|
OPTMICRO-004 |
"No request was provided." |
400 |
optima-as/optimissim/simulations |
|
OPTMICRO-005 |
"Simulation request failed. The provided SubnetId is not in the DB." |
400 |
optima-as/optimissim/simulations |
|
OPTMICRO-006 |
"Simulation group request failed. At least one Scenario ID in the activeScenarioIds list provided doesn’t exist." |
400 |
optima-as/optimissim/simulations |
|
OPTMICRO-007 |
"Request rejected. The number of requested scenarios is greater than the maximum licensed number." + other dynamic information. |
412 |
optima-as/optimissim/simulations |
|
OPTMICRO-008 |
"Simulation request delayed. The requested number of scenarios is not licensed. Any considered previous parallel requests are still running." + other dynamic information. |
412 |
optima-as/optimissim/simulations |
|
OPTMICRO-009 |
"No simulation request has been received from the backend: something went wrong." |
500 |
optima-as/optimissim/simulations |
|
OPTMICRO-010 |
"No micro simulation request found through its associated UUID {MicroSimulationId}." |
404 |
optima-as/optimissim/simulation/{MicroSimulationId} |
|
OPTMICRO-011 |
"No Vissim offline data zip file found through its associated UUID {MicroSimulationId}." |
404 |
optima-as/optimissim/simulation/ {MicroSimulationId}/vissim-data |
|
OPTMICRO-012 |
"No microsimulation subnetwork found through its associated Subnet ID {SubnetworkId}." |
404 |
optima-as/optimissim/subnetwork |
|
OPTMICRO-013 |
"No signal controller found for the subnetwork through its associated Subnet ID {SubnetworkId}." |
404 |
optima-as/optimissim/subnetwork/ {SubnetworkId}/controller |
|
OPTMICRO-014 |
"No scenario found for the subnetwork through its associated Subnet ID {SubnetworkId}." |
404 |
optima-as/optimissim/subnetwork/ {SubnetworkId}/scenario |
|
OPTMICRO-015 |
"Simulation request rejected: the selected simulationPeriod is not positive." |
400 |
optima-as/optimissim/simulations |
|
OPTMICRO-016 |
"Simulation request rejected. The selected simulationPeriod reaches further into the future than the macroscopic simulation. This does not provide reliable results." |
400 |
optima-as/optimissim/simulations |
PTV Optima Micro engine handles a set of statuses associated to the JSON entity involved in API requests, as listed in the table:
| Status | Description |
|---|---|
|
ACCEPTED |
The request has been accepted and is in preparation. |
|
DELAYED |
The request has been delayed due to license constraints. |
|
CANCELLED_QUEUE_TIMEOUT |
The request has been cancelled because it has been in a delayed state for longer than the limit set in <queueCleanupTimeout> (see → <queueCleanupTimeout>, <simulationTimeout> tags). |
|
ISSUED |
The request has been accepted and sent to the back-end. |
|
FAILED |
The request has failed. |
|
FAILED_SIMULATION_TIMEOUT |
The request has failed due to violating the limit set in <simulationTimeout> (see → <queueCleanupTimeout>, <simulationTimeout> tags). |
|
FINISHED |
The request has been completed successfully and the results are available. |
|
RECEIVED |
The request has been accepted and the backend has started computing. |