latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Simulation

Delete a simulation scenario

Delete a simulation scenario. This endpoint only soft-deletes the simulation scenario so any existing references to it would still be valid. However, they cannot be used in any new simulations.

This endpoint will error if the simulation scenario is used in any simulation unit tests.

Permissions

This endpoint requires the following permissions:

  • Simulation:DeleteSimulationScenario on the simulation scenario to delete.
delete/v1/{organization}/simulation/scenario/{simulation_scenario_id}/

Path parameters

organizationstring required
simulation_scenario_idstring required

The ID of the simulation scenario to delete.

The ID of the simulation scenario to delete.

Headers

x-mongo-cluster-namestring nullable

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.

Sec-WebSocket-Protocolstring[]

Response

Succeeded