ROroarkhq
Simulation

Update a simulation group

Changed on

Edits a saved simulation group. Omitted fields keep their current value; notifications, when sent, replaces the settings as a whole. Run groups it already started keep theirs.

A group managed by config as code (configManaged: true) returns 409: change it in the config file.

put/v1/simulation/group/{groupId}

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/simulation/group/{groupId}
  • Auth
    HTTP bearer

Path parameters

groupIdstring uuid required

The simulation group ID

Request body

namestring
descriptionstring nullable

Send null to clear it.

simulationRunPlanIdsstring[]

Replaces the plans, in run order.

Example request

{
  "simulationRunPlanIds": [
    "3c1d2e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
    "6d7e8f9a-0b1c-4d2e-9f3a-4b5c6d7e8f9a"
  ]
}

Response

The updated group

Changes