Skip to content

Questions endpoints

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

Parameter In Type Required
projectId path string (uuid) yes
Status Meaning Body
200 OK PageOfQuestionDto
Parameter In Type Required
projectId path string (uuid) yes

Request body (application/json): QuestionRequest

Field Type Required Notes
text string yes
about array of string (uuid) or null no
origin string or null no
Status Meaning Body
201 Created QuestionDto
400 Bad Request ErrorResponse
409 Conflict ErrorResponse

POST /api/projects/{projectId}/questions/keep

Section titled “POST /api/projects/{projectId}/questions/keep”
Parameter In Type Required
projectId path string (uuid) yes

Request body (application/json): KeepQuestionRequest

Field Type Required Notes
proposalId string (uuid) yes
index integer (int32) or string (int32) yes pattern "^-?(?:0|[1-9]\\d*)$"
Status Meaning Body
200 OK QuestionDto
201 Created QuestionDto
404 Not Found ErrorResponse

POST /api/projects/{projectId}/questions/{questionId}/answer

Section titled “POST /api/projects/{projectId}/questions/{questionId}/answer”
Parameter In Type Required
projectId path string (uuid) yes
questionId path string (uuid) yes

Request body (application/json): AnswerQuestionRequest

Field Type Required Notes
answer string yes
Status Meaning Body
200 OK QuestionDto
404 Not Found ErrorResponse
409 Conflict ErrorResponse

POST /api/projects/{projectId}/questions/{questionId}/drop

Section titled “POST /api/projects/{projectId}/questions/{questionId}/drop”
Parameter In Type Required
projectId path string (uuid) yes
questionId path string (uuid) yes
Status Meaning Body
200 OK QuestionDto
404 Not Found ErrorResponse
409 Conflict ErrorResponse

DELETE /api/projects/{projectId}/questions/{questionId}

Section titled “DELETE /api/projects/{projectId}/questions/{questionId}”
Parameter In Type Required
projectId path string (uuid) yes
questionId path string (uuid) yes
Status Meaning Body
204 No Content none
404 Not Found ErrorResponse