Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Group existing runs, or start one run per plan and group those.

name
string

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

Required string length: 1 - 200
Example:

"Release 4.2 regression"

simulationRunPlanJobIds
string<uuid>[]

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.

Required array length: 2 - 20 elements
Example:
simulationRunPlanIds
string<uuid>[]

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.

Required array length: 2 - 20 elements
Example:

Response

The run group, with its report requested

data
object
required

Several simulation runs read as one.