ROroarkhq
Simulation

Create a simulation group

Changed on

Saves a named set of plans to run together, again and again. Nothing runs yet: POST /v1/simulation/group/{groupId}/run starts one run of every plan and groups them into a run group with one combined report.

Slack channels need Slack connected to the project. Email is on by default.

post/v1/simulation/group

Request

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

Request body

namestring required

What to call the group.

descriptionstring nullable

What the group is for.

simulationRunPlanIdsstring[] required

The plans to run together, in run order (2 to 20). Duplicates are dropped.

Example request

{
  "name": "Release regression",
  "simulationRunPlanIds": [
    "3c1d2e4f-5a6b-4c7d-8e9f-0a1b2c3d4e5f",
    "6d7e8f9a-0b1c-4d2e-9f3a-4b5c6d7e8f9a"
  ],
  "notifications": {
    "email": {
      "enabled": true,
      "recipients": []
    },
    "slack": []
  }
}

Response

The saved group

Changes