List

GET

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

GET

/v1/landscapes/:landscapeId/versions/:versionId/adrs

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

1 {
2   "adrs": [
3     {
4       "commit": 1.1,
5       "name": "string",
6       "status": "accepted",
7       "handleId": "string",
8       "createdAt": "2024-01-15T09:30:00Z",
9       "createdBy": "user",
10       "createdById": "string",
11       "id": "string",
12       "landscapeId": "string",
13       "number": 1.1,
14       "updatedAt": "2024-01-15T09:30:00Z",
15       "updatedBy": "user",
16       "updatedById": "string",
17       "version": 1.1,
18       "versionId": "string",
19       "content": "string",
20       "description": "string",
21       "relatedItems": {},
22       "statusChanges": [
23         {
24           "createdAt": "2024-01-15T09:30:00Z",
25           "createdBy": "user",
26           "createdById": "string",
27           "status": "accepted"
28         }
29       ],
30       "deletedAt": "2024-01-15T09:30:00Z",
31       "deletedBy": "user",
32       "deletedById": "string",
33       "latestEntityId": "string"
34     }
35   ],
36   "nextCursor": "string"
37 }

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequiredformat: "id"

versionIdstring or enumRequired

Query parameters

filterobjectOptional

cursorstringOptional

limitdoubleOptional1-10000Defaults to 1000

Response

adrslist of objects

nextCursorstring

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error