Update

PATCH

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

PATCH

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

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.content.update("landscapeId", "versionId", "diagramId", {
8         body: {},
9     });
10 }
11 main();

1 {
2   "diagramContent": {
3     "comments": {},
4     "commit": 1.1,
5     "connections": {},
6     "objects": {},
7     "createdAt": "2024-01-15T09:30:00Z",
8     "createdBy": "user",
9     "createdById": "string",
10     "groupId": "string",
11     "handleId": "string",
12     "id": "string",
13     "landscapeId": "string",
14     "modelId": "string",
15     "name": "string",
16     "status": "current",
17     "type": "app-diagram",
18     "updatedAt": "2024-01-15T09:30:00Z",
19     "updatedBy": "user",
20     "updatedById": "string",
21     "version": 1.1,
22     "versionId": "string",
23     "deletedAt": "2024-01-15T09:30:00Z",
24     "deletedBy": "user",
25     "deletedById": "string",
26     "latestEntityId": "string",
27     "viewedAt": "2024-01-15T09:30:00Z",
28     "viewedBy": "user",
29     "viewedById": "string"
30   }
31 }

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

diagramIdstringRequired

Query parameters

updateViewedAtbooleanOptional

Request

This endpoint expects an object.

commentsobjectOptional

commitdoubleOptional

connectionsobjectOptional

objectsobjectOptional

Response

diagramContentobject

Authentication

Path parameters

Query parameters

Request

Response

Errors