Export | IcePanel Developer Docs

import { IcePanelClient } from "@icepanel/sdk";
async function main() {
    const client = new IcePanelClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.landscapes.export.create("landscapeId", "versionId", {
        type: "pdf",
        body: {},
    });
}
main();

{
  "landscapeExport": {
    "createdAt": "2024-01-15T09:30:00Z",
    "deleteAt": "2024-01-15T09:30:00Z",
    "error": "string",
    "fileUrl": "string",
    "id": "string",
    "landscapeId": "string",
    "type": "pdf",
    "versionId": "string",
    "completedAt": "2024-01-15T09:30:00Z",
    "filter": {
      "diagramId": "string",
      "flowId": "string",
      "includeDiagrams": true,
      "includeFlows": true,
      "modelObjectId": "string"
    },
    "options": {
      "draftId": "string",
      "orientation": "portrait"
    }
  }
}

Create a background job that exports a landscape in the specified format.

Authentication

X-API-Keystring

API key authentication

AuthorizationBearer

Bearer token authentication

Path parameters

landscapeIdstringRequired

versionIdstringRequired

Query parameters

typeenumRequired

Allowed values:

filterobjectOptional

Request

This endpoint expects an object.

draftIdstringOptional

Fetch and apply draft tasks before producing the export

orientationenumOptional

Orientation to use when exporting to PDF

Allowed values:

Response

landscapeExportobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error