ROroarkhq
Simulation Run Plan Job

Run a simulation plan

Changed on

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

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/simulation/plan/{planId}/job
  • Auth
    HTTP bearer

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

  • 6a09e09bd1caRevision changes
    • info

      added the non-success response with the status

  • b4a59c7057caRevision changes
    • breaking

      the response's body type changed from no type to object for status

    • info

      for the path request parameter planId, the type was generalized from no type to string, and format from no format to uuid

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status