Create | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.model.objects.create("landscapeId", "versionId", {
        body: {
            name: "string",
            parentId: "string",
            type: "actor",
        },
    });
}
main();

{
  "modelObject": {
    "commit": 1.1,
    "external": true,
    "groupIds": [
      "string"
    ],
    "icon": {
      "catalogTechnologyId": "string",
      "name": "string",
      "urlDark": [
        "/organizations/{organizationId}/dark/{catalogTechnologyId}.png",
        "/dark/{catalogTechnologyId}.png"
      ],
      "urlLight": [
        "/organizations/{organizationId}/light/{catalogTechnologyId}.png",
        "/light/{catalogTechnologyId}.png"
      ],
      "url": "string"
    },
    "labels": {},
    "links": {},
    "name": "string",
    "parentId": "string",
    "status": "deprecated",
    "tagIds": [
      "string"
    ],
    "teamIds": [
      "string"
    ],
    "teamOnlyEditing": true,
    "technologyIds": [
      "string"
    ],
    "type": "actor",
    "domainId": "string",
    "handleId": "string",
    "childDiagramIds": [
      "string"
    ],
    "childIds": [
      "string"
    ],
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "diagrams": {},
    "flows": {},
    "id": "string",
    "landscapeId": "string",
    "linked": true,
    "parentIds": [
      "string"
    ],
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "version": 1.1,
    "versionId": "string",
    "caption": "string",
    "description": "string",
    "deletedAt": "2024-01-15T09:30:00Z",
    "deletedBy": "user",
    "deletedById": "string",
    "latestEntityId": "string"
  }
}

Authentication

X-API-Keystring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Request

This endpoint expects an object.

namestringRequired

parentIdstring or nullRequired

Parent model object ID, null for the root level model object

typeenumRequired

captionstringOptional

Short summary of the object shown as the display description

commitdoubleOptional

descriptionstringOptional

externalbooleanOptional

groupIdslist of stringsOptional

IDs of the groups this model object belongs to

iconobject or nullOptional

labelsmap from strings to stringsOptional

Generic key value store used for creating custom integrations

linksmap from strings to objectsOptional

statusenumOptional

Allowed values:

tagIdslist of stringsOptional

Tag IDs assigned to this model

teamIdslist of stringsOptional

Team IDs that own this model object, does not propergate up or down

teamOnlyEditingbooleanOptional

Model object (+child diagram, diagram groups and flows) can only be edited by owners and admins

technologyIdslist of stringsOptional

Technology IDs assigned to this model

domainIdstringOptional

handleIdstringOptional

Response

modelObjectobject

Authentication

Path parameters

Request

Response

Errors