Get

GET

https://api.icepanel.io/v1/landscapes/:landscapeId/versions/:versionId/diagrams/:diagramId/export/image/:diagramExportImageId

GET

/v1/landscapes/:landscapeId/versions/:versionId/diagrams/:diagramId/export/image/:diagramExportImageId

1 import { IcePanelClient } from "@icepanel/sdk";
2 
3 async function main() {
4     const client = new IcePanelClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.diagrams.export.get("landscapeId", "versionId", "diagramId", "diagramExportImageId");
8 }
9 main();

1 {
2   "diagramExportImage": {
3     "createdAt": "2024-01-15T09:30:00Z",
4     "deleteAt": "2024-01-15T09:30:00Z",
5     "diagramId": "string",
6     "error": "string",
7     "fileUrls": {
8       "png": "string",
9       "svg": "string"
10     },
11     "id": "string",
12     "landscapeId": "string",
13     "options": {
14       "draftId": "string",
15       "flowId": "string",
16       "flowPathIds": [
17         "string"
18       ],
19       "focusIds": [
20         "string"
21       ],
22       "groupId": "string",
23       "hideIds": [
24         "string"
25       ],
26       "pinIds": [
27         "string"
28       ],
29       "tab": "tags",
30       "theme": "light"
31     },
32     "versionId": "string",
33     "completedAt": "2024-01-15T09:30:00Z"
34   }
35 }

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

diagramIdstringRequired

diagramExportImageIdstringRequired

Response

diagramExportImageobject

Authentication

Path parameters

Response

Errors