ICicepanel
Landscape

Export

Changed on

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

post/landscapes/{landscapeId}/versions/{versionId}/export

Request

  • Base URL
    https://api.icepanel.io/v1
  • URL
    https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/export
  • Auth
    • API key in header X-API-Key
    • or HTTP bearer

Path parameters

landscapeIdstring required
versionIdstring required

Query parameters

type'pdf' | 'markdown' | 'html' | 'llms' | 'json' | 'object-csv' | 'connection-csv' required
diagramIdstring
flowIdstring
includeDiagramsboolean

Whether or not to include diagrams in PDF exports, defaults to true

includeFlowsboolean

Whether or not to include flows in PDF exports, defaults to true

modelObjectIdstring

Request body

draftIdstring

Fetch and apply draft tasks before producing the export

orientation'portrait' | 'landscape'
schema'v1' | 'v2'

Schema version to use for JSON exports.

v1 (default) produces the legacy format where entities are keyed objects.

v2 produces the same structure as the LandscapeImportData used by the import endpoint, so an export can be imported directly.

Response

OK

Changes

  • 27e82759be89Revision changes
    • info

      the request property default value portrait was removed

    • info

      the request property default value v1 was removed

    • info

      the response's property default value portrait was removed for the status

    • info

      the response's property default value v1 was removed for the status

  • 0fe4f00b60cfRevision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status