API Reference

Initiate a test phase attachment upload

Description

Starts the process to upload and attach a file to a test phase using a graph attachment upload object. The response body will include an uploadUrl. To upload the file contents, perform a PUT or POST 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}/attachmentUpload

🚧

Required OAuth Scopes:

graph:write

Parameters

ParameterInTypeRequiredDescription
testFormIdpathstringtrueThe unique identifier of the test form
testPhaseIdpathstringtrueThe unique identifier of the test phase
bodybodyGraphAttachmentUploadtrueDetails about the attachment

Body parameter example

{
  "fileName": "signature.jpg"
}

Code Samples

curl -X POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/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}/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}/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}/attachmentUpload', headers = headers)

print(r.json())

Returns

202 - Accepted

Contains a pre-signed url that can be used to upload an attachment

HeaderDescription
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}"
}