v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-285553225.5 KB
Simulation Run Plan Job

Run a simulation plan

Create and execute a job for an existing simulation run plan. Optionally provide runtime variables to override plan-defined variables.

post/v1/simulation/plan/{planId}/job

Path parameters

{"stackTrail":"paths:/v1/simulation/plan/{planId}/job:post:parameters:0:schema","oasType":"schema","type":"unknown"}

Simulation run plan ID

Request body

Example request

{
  "variables": {
    "orderNumber": "12345",
    "environment": "staging"
  }
}

Response

Successfully triggered simulation run plan

Example response

{
  "data": {
    "simulationRunPlanId": "9a8b7c6d-5e4f-3210-abcd-ef9876543210",
    "simulationRunPlanJobId": "7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f",
    "status": "PENDING",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}