Update | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.model.objects.update("landscapeId", "versionId", "modelObjectId", {
        body: {},
    });
}
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

modelObjectIdstringRequired

Request

This endpoint expects an object.

captionstringOptional

Short summary of the object shown as the display description

commitdoubleOptional

descriptionstringOptional

externalbooleanOptional

groupIdslist of strings or objectOptional

iconobject or nullOptional

labelsmap from strings to stringsOptional

Generic key value store used for creating custom integrations

linksobjectOptional

namestringOptional

parentIdstring or nullOptional

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

statusenumOptional

Allowed values:

tagIdslist of strings or objectOptional

teamIdslist of strings or objectOptional

teamOnlyEditingbooleanOptional

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

technologyIdslist of strings or objectOptional

typeenumOptional

Response

modelObjectobject

Authentication

Path parameters

Request

Response

Errors