List

GET

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

GET

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

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

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

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Query parameters

filterobjectOptional

Response

diagramGroupslist of objects

Authentication

Path parameters

Query parameters

Response

Errors