Create | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.diagrams.create("landscapeId", "versionId", {
        body: {
            index: 1.1,
            modelId: "string",
            name: "string",
            type: "app-diagram",
        },
    });
}
main();

{
  "diagram": {
    "commit": 1.1,
    "groupId": "string",
    "index": 1.1,
    "labels": {},
    "modelId": "string",
    "name": "string",
    "parentId": "string",
    "pinned": true,
    "status": "current",
    "handleId": "string",
    "type": "app-diagram",
    "commentCount": 1.1,
    "connectionCount": 1.1,
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "id": "string",
    "landscapeId": "string",
    "objectCount": {
      "actor": 1.1,
      "app": 1.1,
      "group": 1.1,
      "component": 1.1,
      "store": 1.1,
      "system": 1.1,
      "area": 1.1,
      "box": 1.1
    },
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "version": 1.1,
    "versionId": "string",
    "description": "string",
    "pinnedAt": "2024-01-15T09:30:00Z",
    "pinnedIndex": 1.1,
    "zoomOverrides": {},
    "deletedAt": "2024-01-15T09:30:00Z",
    "deletedBy": "user",
    "deletedById": "string",
    "latestEntityId": "string"
  },
  "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

Query parameters

updateViewedAtbooleanOptional

Request

This endpoint expects an object.

indexdoubleRequired

modelIdstringRequired

model object id this object belongs to

namestringRequired<=4000 characters

typeenumRequired

commentsmap from strings to objectsOptional

commitdoubleOptional

connectionsmap from strings to objectsOptional

descriptionstringOptional<=950000 characters

groupIdstring or nullOptional

handleIdstringOptional

labelsmap from strings to stringsOptional

objectsmap from strings to objectsOptional

parentIdstring or nullOptional

pinnedbooleanOptional

pinnedAtdatetimeOptional

pinnedIndexdoubleOptional

statusenumOptional

zoomOverridesmap from strings to strings or nullOptional

Custom zoom levels for specific model objects within the diagram. The key is the modelObjectId and the value is the diagram id.

Response

diagramobject

diagramContentobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error