Get

GET

https://api.icepanel.io/v1/landscapes/:landscapeId/versions/:versionId/diagram-groups/:diagramGroupId

GET

/v1/landscapes/:landscapeId/versions/:versionId/diagram-groups/:diagramGroupId

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

1 {
2   "diagramGroup": {
3     "commit": 1.1,
4     "index": 1.1,
5     "labels": {},
6     "modelId": "string",
7     "name": "string",
8     "handleId": "string",
9     "createdAt": "2024-01-15T09:30:00Z",
10     "createdBy": "user",
11     "createdById": "string",
12     "id": "string",
13     "landscapeId": "string",
14     "updatedAt": "2024-01-15T09:30:00Z",
15     "updatedBy": "user",
16     "updatedById": "string",
17     "version": 1.1,
18     "versionId": "string",
19     "deletedAt": "2024-01-15T09:30:00Z",
20     "deletedBy": "user",
21     "deletedById": "string",
22     "latestEntityId": "string"
23   }
24 }

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

diagramGroupIdstringRequired

Response

diagramGroupobject

Authentication

Path parameters

Response

Errors