Upsert | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.drafts.upsert("landscapeId", "versionId", "draftId", {
        body: {
            name: "string",
            status: "in-progress",
        },
    });
}
main();

{
  "draft": {
    "commit": 1.1,
    "handleId": "string",
    "labels": {},
    "name": "string",
    "status": "in-progress",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "id": "string",
    "landscapeId": "string",
    "originVersionId": "string",
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "version": 1.1,
    "versionId": "string",
    "changeSummary": {
      "createdAt": "2024-01-15T09:30:00Z",
      "summary": "string",
      "updatedAt": "2024-01-15T09:30:00Z"
    },
    "summaryDirtiedAt": "2024-01-15T09:30:00Z",
    "deletedAt": "2024-01-15T09:30:00Z",
    "deletedBy": "user",
    "deletedById": "string",
    "headVersionId": "string",
    "latestEntityId": "string",
    "mergedAt": "2024-01-15T09:30:00Z",
    "mergedBy": "user",
    "mergedById": "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

draftIdstringRequired

Request

This endpoint expects an object.

namestringRequired<=4000 characters

statusenumRequired

changeSummaryobjectOptional

commitdoubleOptional

handleIdstringOptional

labelsmap from strings to stringsOptional

summaryDirtiedAtdatetimeOptional

Response

draftobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error