Get

GET

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

GET

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

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

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

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

diagramIdstringRequired

Query parameters

updateViewedAtbooleanOptional

Response

diagramobject

Authentication

Path parameters

Query parameters

Response

Errors