This page is generated from the OpenAPI document of the API (src/Vellum.Web/openapi.json) when the documentation is built.
| Parameter |
In |
Type |
Required |
projectId |
path |
string (uuid) |
yes |
Request body (application/json): ExportRequest
| Field |
Type |
Required |
Notes |
revisionId |
string (uuid) or null |
no |
|
branchId |
string (uuid) or null |
no |
|
format |
string |
no |
default "bundle" |
pinned |
null or PinnedState |
no |
|
| Parameter |
In |
Type |
Required |
projectId |
path |
string (uuid) |
yes |
revisionId |
query |
string (uuid) |
no |
branchId |
query |
string (uuid) |
no |
| Parameter |
In |
Type |
Required |
projectId |
path |
string (uuid) |
yes |
Request body (application/json): BriefRequest
| Field |
Type |
Required |
Notes |
promiseIds |
array of string (uuid) or null |
no |
|
scenarioIds |
array of string (uuid) or null |
no |
|
elementIds |
array of string (uuid) or null |
no |
|
revisionId |
string (uuid) or null |
no |
|
branchId |
string (uuid) or null |
no |
|
changeScanId |
string (uuid) or null |
no |
|
| Parameter |
In |
Type |
Required |
projectId |
path |
string (uuid) |
yes |
Request body (application/json): VerifyRequest