Elements 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}/elements

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

Status	Meaning	Body
200	OK	none

POST /api/projects/{projectId}/elements

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

Request body (application/json): AddElementRequest

Field	Type	Required	Notes
id	string (uuid)	yes
kind	string	yes
name	string	yes
description	string or null	yes
technology	string or null	yes
ownerId	string (uuid) or null	yes
status	string or null	yes
parentId	string (uuid) or null	yes
tags	array of string or null	yes

Status	Meaning	Body
200	OK	none

GET /api/projects/{projectId}/elements/{elementId}

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

Status	Meaning	Body
200	OK	none

PATCH /api/projects/{projectId}/elements/{elementId}

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

Request body (application/json): UpdateElementRequest

Field	Type	Required	Notes
name	string or null	yes
description	string or null	yes
technology	string or null	yes
ownerId	string (uuid) or null	yes
parentId	string (uuid) or null	yes
status	string or null	yes
tags	array of string or null	yes
icon	string or null	yes
setDescription	boolean	no	default false
setTechnology	boolean	no	default false
setOwnerId	boolean	no	default false
setParentId	boolean	no	default false
setIcon	boolean	no	default false
factStatus	string or null	no
provenance	null or ProvenanceInput	no
setProvenance	boolean	no	default false

Status	Meaning	Body
200	OK	none

DELETE /api/projects/{projectId}/elements/{elementId}

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

Status	Meaning	Body
200	OK	none