Views 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}/views

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	none

POST /api/projects/{projectId}/views

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Request body (application/json): CreateViewRequest

Field	Type	Required	Notes
id	string (uuid)	yes
name	string	yes
rootElementId	string (uuid) or null	yes

Status	Meaning	Body
200	OK	none

GET /api/projects/{projectId}/views/{viewId}

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

Status	Meaning	Body
200	OK	none

PATCH /api/projects/{projectId}/views/{viewId}

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

Request body (application/json): UpdateViewRequest

Field	Type	Required	Notes
name	string or null	yes
rootElementId	string (uuid) or null	yes
visibleElementIds	array of string (uuid) or null	yes
activeLens	string or null	yes
updatedAt	string (date-time) or null	yes
setRootElementId	boolean	no	default false
setActiveLens	boolean	no	default false

Status	Meaning	Body
200	OK	none

DELETE /api/projects/{projectId}/views/{viewId}

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

Status	Meaning	Body
200	OK	none

PUT /api/projects/{projectId}/views/{viewId}/layout

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

Request body (application/json): SaveLayoutRequest

Field	Type	Required	Notes
positions	array of SaveLayoutPosition	yes
edges	array of SaveLayoutEdge or null	yes

Status	Meaning	Body
200	OK	none