API Reference

Initiate an export of a matrix attachment


Asynchronously exports an attachment for a matrix to .PDF.

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}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/export


Required OAuth Scopes:



testFormIdpathstringtrueThe unique identifier of the test form
testPhaseIdpathstringtrueThe unique identifier of the test phase
matrixIdpathstringtrueThe unique identifier of the matrix
attachmentIdpathstringtrueThe unique identifier of the attachment
bodybodyGraphAttachmentExporttrueDetails about the attachment upload

Body parameter example

  "format": "pdf"

Code Samples

curl -X POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/export  \ 
-H 'Content-Type: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/export  \ 
Content-Type:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/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}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/export', headers = headers)



202 - Accepted

LocationThe location to poll for the operation result.
Retry-AfterThe number of seconds to wait before polling for a result and between polling attempts.