App: Export app

Note: LOCKED.
This API is extremely reliable and will not be broken unless absolutely necessary.

Method (step 1)

POST

Path

/qrs/app/{id}/export/{token}?skipData={skipData}

Method (step 2)

GET

Path

/tempcontent/.../{appname}.qvf...

Description

Exporting an app is a two-step process using POST and GET methods.

Start export of an existing app, identified by {id}, with the POST method. The export operation itself is identified by {token}, which can be used to cancel an ongoing export; see App: Export app (cancel). The {token} is supplied by the caller and can be any random UUID, which is used as a reference to the ongoing export in the event that the caller wants to cancel it. Start the second step of the export process by specifying the GET method with the actual URI (value of downloadPath) returned in the first step. Note that this call is a potentially long-running operation, dependent primarily on the size of the app and general system load.

Note: An exported app can only be downloaded once, and with the default access rules, it can only be downloaded by the user that initiated the export.

Body (step 1)

-

Return value (step 1)

{ "exportToken": "060dcbca-4782-4f99-a7c4-767190e85355", "appId": "060dcbca-4782-4f99-a7c4-767190e85358", "downloadPath": "/tempcontent/657496a4-21d9-47c7-85f1-e69d8c70085e/ Operations%20Monitor.qvf?serverNodeId=d064a20b-b0a4-4bad-8b21-0535a1e2cb7b", "cancelled": false, "schemaPath": "AppExportResponse" }

Body (step 2)

-

Return value (step 2)

.qvf file

Optional parameters

  • {skipData}: If set to true, the loaded app data will not be included in the exported app. The default value is false.

Did this information help you?

Can you tell us why it did not help you and how we can improve it?