Update | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.diagrams.content.update("landscapeId", "versionId", "diagramId", {
        body: {},
    });
}
main();

{
  "diagramContent": {
    "comments": {},
    "commit": 1.1,
    "connections": {},
    "objects": {},
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "groupId": "string",
    "handleId": "string",
    "id": "string",
    "landscapeId": "string",
    "modelId": "string",
    "name": "string",
    "status": "current",
    "type": "app-diagram",
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "version": 1.1,
    "versionId": "string",
    "deletedAt": "2024-01-15T09:30:00Z",
    "deletedBy": "user",
    "deletedById": "string",
    "latestEntityId": "string",
    "viewedAt": "2024-01-15T09:30:00Z",
    "viewedBy": "user",
    "viewedById": "string"
  }
}

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

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error