Upsert | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.diagrams.groups.upsert("landscapeId", "versionId", "diagramGroupId", {
        body: {
            modelId: "string",
            name: "string",
        },
    });
}
main();

{
  "diagramGroup": {
    "commit": 1.1,
    "index": 1.1,
    "labels": {},
    "modelId": "string",
    "name": "string",
    "handleId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "id": "string",
    "landscapeId": "string",
    "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"
  }
}

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

diagramGroupIdstringRequired

Request

This endpoint expects an object.

modelIdstringRequired

namestringRequired

commitdoubleOptional

handleIdstringOptional

indexdoubleOptional

labelsmap from strings to stringsOptional

Response

diagramGroupobject

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error