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: "landscapeId",
        versionId: "versionId",
        diagramId: "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

Operations to apply to the comments on the diagram

commitdoubleOptional

The commit number of the diagram content, incremented on each change

connectionsobjectOptional

Operations to apply to the connections on the diagram

objectsobjectOptional

Operations to apply to the objects on the diagram

Response

diagramContentobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error