Scenarios endpoints

This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.

GET /api/projects/{projectId}/scenarios

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
cursor	query	string	no
limit	query	integer (int32) or string (int32)	no

Status	Meaning	Body
200	OK	PageOfScenarioSummaryDto

POST /api/projects/{projectId}/scenarios

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Request body (application/json): Scenario

Field	Type	Required	Notes
id	ScenarioId	yes
name	string	yes
steps	array of Step	yes
faults	array of Fault	yes
assertions	array of Assertion	yes

Status	Meaning	Body
201	Created	Scenario

GET /api/projects/{projectId}/scenarios/{scenarioId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
scenarioId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	ScenarioDto

PUT /api/projects/{projectId}/scenarios/{scenarioId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
scenarioId	path	string (uuid)	yes

Request body (application/json): Scenario

Field	Type	Required	Notes
id	ScenarioId	yes
name	string	yes
steps	array of Step	yes
faults	array of Fault	yes
assertions	array of Assertion	yes

Status	Meaning	Body
200	OK	Scenario

DELETE /api/projects/{projectId}/scenarios/{scenarioId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
scenarioId	path	string (uuid)	yes

Status	Meaning	Body
204	No Content	none

POST /api/projects/{projectId}/scenarios/{scenarioId}/run

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
scenarioId	path	string (uuid)	yes
branchId	query	string (uuid)	no

Status	Meaning	Body
200	OK	RunScenarioResponse