Delete a simulation group

It enables the deletion 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

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 simulation 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 may 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 may be classified under this code.

Main examples:

  • If the simulation group to be deleted is not present.
  • If an exception occurs during the physical deletion of the simulation 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 can have only one of two possible statuses:

  • DONE_KPI
  • ERROR_KPI

See → Getting the status of a simulation.

If in the group there are simulations associated to different status values, they are not all completed and the group cannot 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.