List

GET

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

GET

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

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.list("landscapeId", "versionId", {});
8 }
9 main();

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

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Query parameters

filterobjectOptional

Response

draftslist of objects

Authentication

Path parameters

Query parameters

Response

Errors