Skip to main content
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.
Calls POST /v1/simulation/run-group

​
Options

​
string
What to call the group. Defaults to the plans’ names when starting plans, and to the runs’ plan names when grouping existing runs.
​
array
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. Repeatable.
​
array
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. Repeatable.

​
Example

Every command also takes the global options and sets one of the exit codes.