Delete a simulation group

Enables to delete a simulations 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

DELETE 

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

The path parameter idno must be specified. It must be a valid simulations group identifier.

Request parameters

Not applicable.

Request content-type

Not applicable

Request body (payload)

Not applicable

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

Several conditions can be classified under this code.

Main examples:

  • If the simulations group to be deleted it is not present.
  • If an exception occurs during the physical deletion of the simulations group.

409 Conflict

The request could not be completed due to a conflict with the current state of the resource.

All simulations of the group must be in only two possible status:

  • DONE_KPI
  • ERROR_KPI

See → Getting the status of a simulation.

If in the group are present simulations associated to different status values, they are not completed and the group can not be deleted.

Response content-type

Not applicable.

Response entity

Not applicable.

Request

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

Response status

HTTP status Description

200 OK

Result of the processed request.

Response output

Not applicable.