Update | IcePanel Developer Docs

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

AuthorizationBearer

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

Path parameters

landscapeIdstringRequired

versionIdstringRequired

draftIdstringRequired

Request

This endpoint expects an object.

changeSummaryobjectOptional

commitdoubleOptional

handleIdstringOptional

labelsmap from strings to stringsOptional

namestringOptional

statusenumOptional

Allowed values:

summaryDirtiedAtdatetimeOptional

Response

draftobject

Authentication

Path parameters

Request

Response

Errors