Sign in
Simulation Run Plan

Get run plan by ID

Returns a specific simulation run plan by its ID.

get/v1/simulation/plan/{planId}

Path parameters

planIdstring uuid required

The ID of the run plan to retrieve

Response

The requested run plan

Example response

{
  "data": {
    "scenarios": [
      {
        "variables": {
          "customerName": "John Doe",
          "appointmentDate": "2024-02-15"
        }
      }
    ],
    "flows": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "happyPath": true,
        "edgeCases": [
          {
            "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "variables": {
              "tier": "premium"
            }
          }
        ]
      }
    ]
  }
}

Changes