POST
/
landscapes
/
{landscapeId}
/
versions
/
{versionId}
/
export
curl --request POST \
  --url https://api.icepanel.io/v1/landscapes/{landscapeId}/versions/{versionId}/export \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "orientation": "portrait"
}'
{
  "landscapeExport": {
    "completedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z",
    "deleteAt": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "fileUrl": "<string>",
    "filter": {
      "diagramId": "<string>",
      "flowId": "<string>",
      "includeDiagrams": true,
      "includeFlows": true,
      "modelObjectId": "<string>"
    },
    "id": "<string>",
    "landscapeId": "<string>",
    "options": {
      "orientation": "portrait"
    },
    "type": "pdf",
    "versionId": "<string>"
  }
}

Headers

Authorization
string
required

Path Parameters

landscapeId
string
required
versionId
string
required

Query Parameters

type
enum<string>
required
Available options:
pdf,
md,
html
filter
object

Body

application/json

Response

200
application/json
OK

The response is of type object.