Relationships 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}/relationships

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
branchId	query	string (uuid)	no
fromId	query	string (uuid)	no
toId	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}/relationships

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

Request body (application/json): AddRelationshipRequest

Field	Type	Required	Notes
id	string (uuid)	yes
fromId	string (uuid)	yes
toId	string (uuid)	yes
label	string or null	yes
technology	string or null	yes
kind	string or null	no

Status	Meaning	Body
200	OK	none

GET /api/projects/{projectId}/relationships/{relationshipId}

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

Status	Meaning	Body
200	OK	none

PATCH /api/projects/{projectId}/relationships/{relationshipId}

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

Request body (application/json): UpdateRelationshipRequest

Field	Type	Required	Notes
label	string or null	yes
technology	string or null	yes
lineShape	string or null	yes
setLabel	boolean	no	default false
setTechnology	boolean	no	default false
setLineShape	boolean	no	default false
kind	string or null	no
setKind	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}/relationships/{relationshipId}

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

Status	Meaning	Body
200	OK	none