ROroarkhq
Simulation

Create a run group

Changed on

Groups several simulation runs so they read as one, and starts generating the group report: one document across every run, with a scorecard summed across them and the issues found, each merged from the per-run debriefs.

Send simulationRunPlanJobIds to group runs that already exist (runs still in progress are fine: the report waits for them). Send simulationRunPlanIds to start one run of each plan and group those; this places real calls, exactly as starting each plan would.

Poll GET /v1/simulation/run-group/{groupId} until latestReport.status is READY.

post/v1/simulation/run-group

Request

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

Request body

namestring

What to call the group. Defaults to the plans' names when starting plans, and to the runs' plan names when grouping existing runs.

simulationRunPlanJobIdsstring[]

Runs that already exist, in display order (2 to 20). Runs still in progress are fine: the group report waits for them. Send this or simulationRunPlanIds, not both.

simulationRunPlanIdsstring[]

Plans to run once each, in display order (2 to 20). Each plan starts a run, exactly as POST /v1/simulation/plan/{planId}/job would. Send this or simulationRunPlanJobIds, not both.

Example request

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

Response

The run group, with its report requested

Changes