API Reference

Initiate a matrix attachment upload


Starts the process to upload and attach a file to a matrix using a graph attachment upload object. The response body will include an uploadUrl. To upload the file contents, perform a PUT on the uploadUrl with the same authentication credentials and flow as the attachmentUpload request. For more details, see Authentication documentation.

The response also includes a Location header, which indicates where to poll for operation results. For more details on long-running job polling, see Operations endpoint.

POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachmentUpload


Required OAuth Scopes:



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

Body parameter example

  "fileName": "signature.jpg"

Code Samples

curl -X POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachmentUpload  \ 
-H 'Content-Type: application/json' \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachmentUpload  \ 
Content-Type:application/json \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=POST "https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachmentUpload" \
 --output-document -  \ 
 --header 'Content-Type: application/json' \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'

r = requests.post('https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/attachmentUpload', headers = headers)



202 - Accepted

Contains a pre-signed url that can be used to upload an attachment. The Location header also contains a url for an Operation that can be polled to find out if the upload was successful.

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

Example Responses

  "uploadUrl": "{opaqueUrl}"