Stress 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}/stress/requirements

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

Status	Meaning	Body
200	OK	StressRequirements

GET /api/projects/{projectId}/stress/defaults

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	StressProfileDefaults

GET /api/projects/{projectId}/stress/profiles

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	array of StressProfileSummaryDto

POST /api/projects/{projectId}/stress/profiles

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Request body (application/json): StressProfile

Field	Type	Required	Notes
name	string	yes
scenarioId	string (uuid)	yes
seed	string	yes
arrivals	Arrivals	yes
resources	array of ResourceAssumption	yes
serviceTimes	array of ServiceTimeAssumption	yes
subscriptions	array of SubscriptionAssumption	yes
branches	array of BranchAssumption	yes
overrides	array of PolicyOverride	yes
outages	array of Outage	yes

Status	Meaning	Body
201	Created	StressProfileDto

GET /api/projects/{projectId}/stress/profiles/{profileId}

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

Status	Meaning	Body
200	OK	StressProfileDto

PUT /api/projects/{projectId}/stress/profiles/{profileId}

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

Request body (application/json): StressProfile

Field	Type	Required	Notes
name	string	yes
scenarioId	string (uuid)	yes
seed	string	yes
arrivals	Arrivals	yes
resources	array of ResourceAssumption	yes
serviceTimes	array of ServiceTimeAssumption	yes
subscriptions	array of SubscriptionAssumption	yes
branches	array of BranchAssumption	yes
overrides	array of PolicyOverride	yes
outages	array of Outage	yes

Status	Meaning	Body
200	OK	StressProfileDto

DELETE /api/projects/{projectId}/stress/profiles/{profileId}

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

Status	Meaning	Body
204	No Content	none

GET /api/projects/{projectId}/stress/profiles/{profileId}/runs

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

Status	Meaning	Body
200	OK	array of StressRunSummaryDto

POST /api/projects/{projectId}/stress/profiles/{profileId}/runs

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

Status	Meaning	Body
201	Created	StressRunDto
422	Unprocessable Entity	StressRefusedResponse
429	Too Many Requests	ErrorResponse

GET /api/projects/{projectId}/stress/runs/{runId}

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

Status	Meaning	Body
200	OK	StressRunDto

DELETE /api/projects/{projectId}/stress/runs/{runId}

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

Status	Meaning	Body
204	No Content	none

GET /api/projects/{projectId}/stress/compare

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
left	query	string (uuid)	yes
right	query	string (uuid)	yes

Status	Meaning	Body
200	OK	StressComparisonDto