Landscape

Export

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

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

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

Changed in 3 of the 17 revisions of this API.210

    • the orientation request property default value portrait was removed

      request-property-default-value-removed

    • the schema request property default value v1 was removed

      request-property-default-value-removed

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

      response-property-default-value-removed

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

      response-property-default-value-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • added the new optional request property schema

      new-optional-request-property

    • added the non-success response with the status 429

      response-non-success-status-added

    • added the optional property landscapeExport/options/schema to the response with the 200 status

      response-optional-property-added

    • added the new connection-csv enum value to the landscapeExport/type response property for the response status 200

      response-property-enum-value-added

    • added the new object-csv enum value to the landscapeExport/type response property for the response status 200

      response-property-enum-value-added

    • added the new enum value connection-csv to the query request parameter type

      request-parameter-enum-value-added

    • added the new enum value object-csv to the query request parameter type

      request-parameter-enum-value-added

    • added the non-success response with the status 400

      response-non-success-status-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog