Description
Asynchronously downloads an attachment from a matrix.
Responses include a Location header, which indicates where to poll for download results. For more details on long-running job polling, see Operations endpoint. When the download is ready, its status will be completed, and the response body includes a resourceURL. To download the file, perform a GET on the resourceURL with the same authentication credentials and flow as the download request. For more details, see Authentication documentation.
POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/download
Required OAuth Scopes:
graph:read
Parameters
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
| testFormId | path | string | true | The unique identifier of the test form |
| testPhaseId | path | string | true | The unique identifier of the test phase |
| matrixId | path | string | true | The unique identifier of the matrix |
| attachmentId | path | string | true | The unique identifier of the attachment |
Code Samples
curl -X POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/download \
-H 'Authorization: Bearer {access-token}'
http POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/download \
Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/download" \
--output-document - \
--header 'Authorization: Bearer {access-token}'
import requests
headers = {
'Authorization': 'Bearer {access-token}'
}
r = requests.post('https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachments/{attachmentId}/download', 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. |