Operations 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}/operations

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

Status	Meaning	Body
200	OK	PageOfOperationDto

POST /api/projects/{projectId}/operations

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

Request body (application/json): AddOperationRequest

Field	Type	Required	Notes
id	string (uuid)	yes
ownerId	string (uuid)	yes
name	string	yes
transport	string	yes
requestSchemaId	string (uuid) or null	yes
responseSchemaId	string (uuid) or null	yes
timeoutMs	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
retry	null or RetryDto	yes

Status	Meaning	Body
201	Created	OperationDto

PATCH /api/projects/{projectId}/operations/{operationId}

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

Request body (application/json): UpdateOperationRequest

Field	Type	Required	Notes
name	string or null	yes
ownerId	string (uuid) or null	yes
transport	string or null	yes
requestSchemaId	string (uuid) or null	yes
responseSchemaId	string (uuid) or null	yes
timeoutMs	integer (int32) or string (int32) or null	yes	pattern "^-?(?:0|[1-9]\\d*)$"
retry	null or RetryDto	yes
setRequestSchemaId	boolean	no	default false
setResponseSchemaId	boolean	no	default false
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

Status	Meaning	Body
200	OK	OperationDto

DELETE /api/projects/{projectId}/operations/{operationId}

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

Status	Meaning	Body
204	No Content	none