Upsert

PUT

https://api.icepanel.io/v1/landscapes/:landscapeId/versions/:versionId/drafts/:draftId

PUT

/v1/landscapes/:landscapeId/versions/:versionId/drafts/:draftId

1 import { IcePanelClient } from "@icepanel/sdk";
2 
3 async function main() {
4     const client = new IcePanelClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.drafts.upsert("landscapeId", "versionId", "draftId", {
8         body: {
9             name: "string",
10             status: "in-progress",
11         },
12     });
13 }
14 main();

1 {
2   "draft": {
3     "commit": 1.1,
4     "handleId": "string",
5     "labels": {},
6     "name": "string",
7     "status": "in-progress",
8     "createdAt": "2024-01-15T09:30:00Z",
9     "createdBy": "user",
10     "createdById": "string",
11     "id": "string",
12     "landscapeId": "string",
13     "originVersionId": "string",
14     "updatedAt": "2024-01-15T09:30:00Z",
15     "updatedBy": "user",
16     "updatedById": "string",
17     "version": 1.1,
18     "versionId": "string",
19     "changeSummary": {
20       "createdAt": "2024-01-15T09:30:00Z",
21       "summary": "string",
22       "updatedAt": "2024-01-15T09:30:00Z"
23     },
24     "summaryDirtiedAt": "2024-01-15T09:30:00Z",
25     "deletedAt": "2024-01-15T09:30:00Z",
26     "deletedBy": "user",
27     "deletedById": "string",
28     "latestEntityId": "string",
29     "mergedAt": "2024-01-15T09:30:00Z",
30     "mergedBy": "user",
31     "mergedById": "string",
32     "viewedAt": "2024-01-15T09:30:00Z",
33     "viewedBy": "user",
34     "viewedById": "string"
35   }
36 }

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

draftIdstringRequired

Request

This endpoint expects an object.

namestringRequired

statusenumRequired

Allowed values:

changeSummaryobjectOptional

commitdoubleOptional

handleIdstringOptional

labelsmap from strings to stringsOptional

summaryDirtiedAtdatetimeOptional

Response

draftobject

Authentication

Path parameters

Request

Response

Errors