API Reference

Update samples

Description

Updates multiple samples, with the requestBody of each specifying columns to update by their IDs. Columns not included in the request remain as-is.

POST /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/update

🚧

Required OAuth Scopes:

graph:write

Parameters

ParameterInTypeRequiredDescription
testFormIdpathstringtrueThe unique identifier of the test form
testPhaseIdpathstringtrueThe unique identifier of the test phase
matrixIdpathstringtrueThe unique identifier of the matrix
bodybodyMatrixSamplestrueDetails about the samples to update

Body parameter example

[
  {
    "dataValues": [
      {
        "column": "6d870cd1-7bbe-4b14-b85d-f152913b068c",
        "value": 23897
      }
    ],
    "id": "3dd42da0-3543-4e03-ac4a-2ddefebe27d6",
    "resultValues": [
      {
        "column": "674a9283-fd03-425d-bd62-0552263699e2",
        "value": "PASS"
      }
    ]
  },
  {
    "dataValues": [
      {
        "column": "6d870cd1-7bbe-4b14-b85d-f152913b068c",
        "value": 9125
      }
    ],
    "id": "4ee53eb1-3543-4e03-ac4a-3eef0fcf38e7",
    "resultValues": [
      {
        "column": "674a9283-fd03-425d-bd62-0552263699e2",
        "value": "FAIL"
      }
    ]
  }
]

Code Samples

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

print(r.json())

Returns

202 - Accepted

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.