Description
Asynchronously exports a test form.
Responses include a Location
header, which indicates where to poll for export results. For more details on long-running job polling, see Operations endpoint. When the export completes, its status will be completed
, and the response body includes a resourceURL
. To download the exported file, perform a GET on the resourceURL
with the same authentication credentials and flow as the export request. For more details, see Authentication documentation.
POST
/testForms/{testFormId}/export
Required OAuth Scopes:
graph:read
Parameters
Parameter | In | Type | Required | Description |
---|---|---|---|---|
testFormId | path | string | true | The unique identifier of the test form |
body | body | TestFormExport | true | Details about the test form export |
Body parameter example
{
"format": "xlsx"
}
Code Samples
curl -X POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/export \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {access-token}'
http POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/export \
Content-Type:application/json \
Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/export" \
--output-document - \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {access-token}'
import requests
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/export', headers = headers)
print(r.headers['Location'])
Returns
202 - Accepted
Header | Description |
---|---|
Location | The location to poll for the operation result. |
Retry-After | The number of seconds to wait before polling for a result and between polling attempts. |