API Reference

Update a single sample

Description

Fully replaces all elements of a sample; this is not a partial update.

PUT /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/{sampleId}

🚧

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
sampleIdpathstringtrueThe unique identifier of the sample
bodybodyMatrixSampletrueAll properties for the sample, not just those to update

Body parameter example

{
  "dataValues": [
    {
      "column": "d795d7a3-e7f7-4b3f-be6a-109653b2929b",
      "value": 124
    },
    {
      "column": "fbd818ec-4fd1-42ad-9112-3c80e71dc2dc",
      "value": 101.2
    }
  ],
  "id": "ce4a6c7f-15ad-445c-a76a-f457d53f667a",
  "resultValues": [
    {
      "column": "d795d7a3-e7f7-4b3f-be6a-109653b2c34d",
      "value": "PASS"
    }
  ]
}

Code Samples

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

print(r.json())

Returns

200 - OK

This object represents a single row of a matrix.

Example Responses


{
  "id": "ce4a6c7f-15ad-445c-a76a-f457d53f667a",
  "dataValues": [
    {
      "column": "d795d7a3-e7f7-4b3f-be6a-109653b2929b",
      "value": 124
    },
    {
      "column": "fbd818ec-4fd1-42ad-9112-3c80e71dc2dc",
      "value": 101.2
    }
  ],
  "resultValues": [
    {
      "column": "d795d7a3-e7f7-4b3f-be6a-109653b2c34d",
      "value": "PASS"
    }
  ]
}