Imports 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}/imports/{importId}/impact

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

Status	Meaning	Body
200	OK	ChangeImpactDto
404	Not Found	ErrorResponse
409	Conflict	ErrorResponse

GET /api/projects/{projectId}/imports

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

Status	Meaning	Body
200	OK	PageOfScanDto

POST /api/projects/{projectId}/imports

Parameter	In	Type	Required
projectId	path	string (uuid)	yes

Request body (application/json): StartScanRequest

Field	Type	Required	Notes
repository	string or null	yes
ref	string or null	yes
includePaths	array of string or null	yes
excludePaths	array of string or null	yes

Status	Meaning	Body
202	Accepted	StartScanResponse
400	Bad Request	ErrorResponse
409	Conflict	ErrorResponse
429	Too Many Requests	ErrorResponse

GET /api/projects/{projectId}/imports/{importId}

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

Status	Meaning	Body
200	OK	ScanDetailDto
404	Not Found	ErrorResponse

POST /api/projects/{projectId}/imports/{importId}/cancel

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

Status	Meaning	Body
202	Accepted	none
409	Conflict	ErrorResponse

POST /api/projects/{projectId}/imports/{importId}/resume

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

Status	Meaning	Body
202	Accepted	none
409	Conflict	ErrorResponse
429	Too Many Requests	ErrorResponse

POST /api/projects/{projectId}/imports/{importId}/track

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

Status	Meaning	Body
200	OK	ScanDetailDto
404	Not Found	ErrorResponse
409	Conflict	ErrorResponse

GET /api/projects/{projectId}/imports/{importId}/proposals

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
importId	path	string (uuid)	yes
status	query	string	no
action	query	string	no
entityKind	query	string	no
cursor	query	string	no
limit	query	integer (int32) or string (int32)	no

Status	Meaning	Body
200	OK	ProposalPage

GET /api/projects/{projectId}/imports/{importId}/proposals/{proposalId}

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
importId	path	string (uuid)	yes
proposalId	path	string (uuid)	yes

Status	Meaning	Body
200	OK	ProposalDto
404	Not Found	ErrorResponse

POST /api/projects/{projectId}/imports/{importId}/proposals/decide

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

Request body (application/json): DecideProposalsRequest

Field	Type	Required	Notes
accept	array of string (uuid) or null	yes
reject	array of string (uuid) or null	yes
relink	array of RelinkChoice or null	no
acknowledgeImpact	boolean	no	default false

Status	Meaning	Body
200	OK	DecideProposalsResponse
400	Bad Request	ErrorResponse
409	Conflict	ErrorResponse

GET /api/projects/{projectId}/imports/{importId}/evidence

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

Status	Meaning	Body
200	OK	PageOfEvidenceItemDto

GET /api/projects/{projectId}/imports/{importId}/source

Parameter	In	Type	Required
projectId	path	string (uuid)	yes
importId	path	string (uuid)	yes
path	query	string	no
startLine	query	integer (int32) or string (int32)	no
endLine	query	integer (int32) or string (int32)	no

Status	Meaning	Body
200	OK	SourceWindowDto
403	Forbidden	ErrorResponse
404	Not Found	ErrorResponse
409	Conflict	ErrorResponse