Get | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.adrs.get("landscapeId", "latest", "adrId");
}
main();

{
  "adr": {
    "commit": 1.1,
    "name": "string",
    "status": "accepted",
    "handleId": "string",
    "createdAt": "2024-01-15T09:30:00Z",
    "createdBy": "user",
    "createdById": "string",
    "id": "string",
    "landscapeId": "string",
    "number": 1.1,
    "updatedAt": "2024-01-15T09:30:00Z",
    "updatedBy": "user",
    "updatedById": "string",
    "version": 1.1,
    "versionId": "string",
    "content": "string",
    "description": "string",
    "relatedItems": {},
    "statusChanges": [
      {
        "createdAt": "2024-01-15T09:30:00Z",
        "createdBy": "user",
        "createdById": "string",
        "status": "accepted"
      }
    ],
    "deletedAt": "2024-01-15T09:30:00Z",
    "deletedBy": "user",
    "deletedById": "string",
    "latestEntityId": "string"
  }
}

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequiredformat: "id"

versionIdstring or enumRequired

adrIdstringRequiredformat: "id"

Response

adrobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error