Export 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}/export
Section titled “GET /api/projects/{projectId}/export”| Parameter | In | Type | Required |
|---|---|---|---|
projectId |
path | string (uuid) | yes |
format |
query | string | no |
| Status | Meaning | Body |
|---|---|---|
200 |
OK | none |
GET /api/projects/{projectId}/export/structurizr
Section titled “GET /api/projects/{projectId}/export/structurizr”| Parameter | In | Type | Required |
|---|---|---|---|
projectId |
path | string (uuid) | yes |
revisionId |
query | string (uuid) | no |
| Status | Meaning | Body |
|---|---|---|
200 |
OK | string |
400 |
Bad Request | ErrorResponse |
GET /api/projects/{projectId}/views/{viewId}/export/svg
Section titled “GET /api/projects/{projectId}/views/{viewId}/export/svg”| Parameter | In | Type | Required |
|---|---|---|---|
projectId |
path | string (uuid) | yes |
viewId |
path | string (uuid) | yes |
revisionId |
query | string (uuid) | no |
| Status | Meaning | Body |
|---|---|---|
200 |
OK | string |
400 |
Bad Request | ErrorResponse |
404 |
Not Found | ErrorResponse |
GET /api/projects/{projectId}/views/{viewId}/export/mermaid
Section titled “GET /api/projects/{projectId}/views/{viewId}/export/mermaid”| Parameter | In | Type | Required |
|---|---|---|---|
projectId |
path | string (uuid) | yes |
viewId |
path | string (uuid) | yes |
revisionId |
query | string (uuid) | no |
| Status | Meaning | Body |
|---|---|---|
200 |
OK | string |
400 |
Bad Request | ErrorResponse |
404 |
Not Found | ErrorResponse |