List

GET

https://api.icepanel.io/v1/landscapes/:landscapeId/versions/:versionId/diagrams

GET

/v1/landscapes/:landscapeId/versions/:versionId/diagrams

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.list("landscapeId", "versionId", {});
8 }
9 main();

1 {
2   "diagrams": [
3     {
4       "commit": 1.1,
5       "groupId": "string",
6       "index": 1.1,
7       "labels": {},
8       "modelId": "string",
9       "name": "string",
10       "parentId": "string",
11       "pinned": true,
12       "status": "current",
13       "handleId": "string",
14       "type": "app-diagram",
15       "commentCount": 1.1,
16       "connectionCount": 1.1,
17       "createdAt": "2024-01-15T09:30:00Z",
18       "createdBy": "user",
19       "createdById": "string",
20       "id": "string",
21       "landscapeId": "string",
22       "objectCount": {
23         "actor": 1.1,
24         "app": 1.1,
25         "group": 1.1,
26         "component": 1.1,
27         "store": 1.1,
28         "system": 1.1,
29         "area": 1.1,
30         "box": 1.1
31       },
32       "updatedAt": "2024-01-15T09:30:00Z",
33       "updatedBy": "user",
34       "updatedById": "string",
35       "version": 1.1,
36       "versionId": "string",
37       "description": "string",
38       "pinnedAt": "2024-01-15T09:30:00Z",
39       "pinnedIndex": 1.1,
40       "zoomOverrides": {},
41       "deletedAt": "2024-01-15T09:30:00Z",
42       "deletedBy": "user",
43       "deletedById": "string",
44       "latestEntityId": "string"
45     }
46   ]
47 }

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Query parameters

filterobjectOptional

Response

diagramslist of objects

Authentication

Path parameters

Query parameters

Response

Errors