Initiate an upload of a sample attachment

Description

Starts the process to upload and attach a file to a sample 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}/samples/{sampleId}/attachmentUpload

🚧
Required OAuth Scopes:
graph:write

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
sampleId	path	string	true	The unique identifier of the sample
body	body	GraphAttachmentUpload	true	Details 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}/samples/{sampleId}/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}/samples/{sampleId}/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}/samples/{sampleId}/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}/samples/{sampleId}/attachmentUpload', headers = headers)

print(r.headers['Location'])

Returns

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.

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.

Example Responses


{
  "uploadUrl": "{opaqueUrl}"
}