Decisions 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}/decisions

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	PageOfDecisionDto

POST /api/projects/{projectId}/decisions

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Request body (application/json): DecisionRequest

Field	Type	Required	Notes
title	string	yes
context	string or null	yes
decision	string	yes
alternatives	array of Alternative or null	yes
consequences	string or null	yes
affectedIds	array of string (uuid) or null	yes
settles	array of Settles or null	yes
supersedes	string (uuid) or null	yes
origin	string or null	no

Status	Meaning	Body
201	Created	DecisionDto
400	Bad Request	ErrorResponse
409	Conflict	ErrorResponse

GET /api/projects/{projectId}/decisions/export

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	string

GET /api/projects/{projectId}/decisions/{decisionId}

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

Status	Meaning	Body
200	OK	DecisionDto
404	Not Found	ErrorResponse

PUT /api/projects/{projectId}/decisions/{decisionId}

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

Request body (application/json): DecisionRequest

Field	Type	Required	Notes
title	string	yes
context	string or null	yes
decision	string	yes
alternatives	array of Alternative or null	yes
consequences	string or null	yes
affectedIds	array of string (uuid) or null	yes
settles	array of Settles or null	yes
supersedes	string (uuid) or null	yes
origin	string or null	no

Status	Meaning	Body
200	OK	DecisionDto
409	Conflict	ErrorResponse

DELETE /api/projects/{projectId}/decisions/{decisionId}

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

Status	Meaning	Body
204	No Content	none
409	Conflict	ErrorResponse

GET /api/projects/{projectId}/decisions/{decisionId}/export

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

Status	Meaning	Body
200	OK	string
404	Not Found	ErrorResponse

POST /api/projects/{projectId}/decisions/{decisionId}/accept

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

Request body (application/json): AcceptDecisionRequest

Field	Type	Required	Notes
contentHash	string or null	yes
revisionId	string (uuid) or null	no
branchId	string (uuid) or null	no

Status	Meaning	Body
200	OK	DecisionDto
400	Bad Request	ErrorResponse
403	Forbidden	ErrorResponse
409	Conflict	DecisionChangedResponse

POST /api/projects/{projectId}/decisions/{decisionId}/reject

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

Request body (application/json): RejectDecisionRequest

Field	Type	Required	Notes
reason	string or null	yes
contentHash	string or null	no

Status	Meaning	Body
200	OK	DecisionDto
400	Bad Request	ErrorResponse
403	Forbidden	ErrorResponse
409	Conflict	DecisionChangedResponse