Sign in
latestOpenAPI 3.1.02026-08-221163801019.2 KB

f0f28319e448

Simulation

Create a simulation scenario

Create a simulation scenario.

Permissions

This endpoint requires the following permissions:

  • Simulation:CreateSimulationScenario for the simulation scenario.
  • Simulation:ModifySimulationScenario for the simulation scenario.
post/v1/{organization}/simulation/scenario/

Path parameters

organizationstring required

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[]

Request body

namestring required
tagsobject required

The tags of the simulation scenario. Both the key and the value can only contain alphanumeric characters, underscores, or spaces.

Response

Succeeded.

simulation_scenario_idstring required

The ID of the created simulation scenario.