Simulation Run Plan Job

Run a simulation plan

Deprecated: use POST /v1/simulation/run, which does the same thing and can also take the plan configuration inline, so a one-off run does not have to create a plan first.

Creates and executes 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

planIdstring uuid required

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"
  }
}

Changes

Changed in 3 of the 105 revisions of this API.299

Aug 26, 2026b4a59c7057ca16See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 404
  response-body-type-changed
- ○
  for the path request parameter planId, the type/format was generalized from / to string/uuid
  request-parameter-type-generalized
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 404 status
  response-optional-property-added
- ○
  added the required property code to the response with the 404 status
  response-required-property-added
- ○
  added the required property message to the response with the 404 status
  response-required-property-added
- ○
  added the required property type to the response with the 404 status
  response-required-property-added
Aug 20, 20269080f23131181See the full diff
- ●
  added the new PREPARING_CAPACITY enum value to the data/status response property for the response status 200
  response-property-enum-value-added
Aug 17, 2026887b091b3d81183See the full diff
- ▲
  removed subschema #2 from the variables request property anyOf list
  request-property-any-of-removed
- ●
  added the new conflict enum value to the type response property for the response status 401
  response-property-enum-value-added
- ●
  added the new conflict enum value to the type response property for the response status 403
  response-property-enum-value-added
- ●
  added the new conflict enum value to the type response property for the response status 429
  response-property-enum-value-added
- ●
  added the new conflict enum value to the type response property for the response status 500
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 401
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 403
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 429
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 500
  response-property-enum-value-added
- ○
  endpoint deprecated
  endpoint-deprecated
- ○
  added subschema #2 subschema #3 to the variables request property anyOf list
  request-property-any-of-added
- ○
  added the non-success response with the status 402
  response-non-success-status-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history