API Reference

Insert samples

Description

Inserts multiple samples into a matrix, and appends new samples to the end of the matrix. You can leave columns empty for later use. For new samples, provide no IDs; the endpoint generates them.

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

🚧

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 insert

Body parameter example

[
  {
    "dataValues": [
      {
        "column": "d795d7a3-e7f7-4b3f-be6a-109653b2929b",
        "value": 123
      },
      {
        "column": "fbd818ec-4fd1-42ad-9112-3c80e71dc2dc",
        "value": 101.1
      }
    ],
    "resultValues": [
      {
        "column": "d795d7a3-e7f7-4b3f-be6a-109653b2c34d",
        "value": "PASS"
      }
    ]
  },
  {
    "dataValues": [
      {
        "column": "d795d7a3-e7f7-4b3f-be6a-109653b2929b",
        "value": 456
      },
      {
        "column": "fbd818ec-4fd1-42ad-9112-3c80e71dc2dc",
        "value": 202.2
      }
    ],
    "resultValues": [
      {
        "column": "d795d7a3-e7f7-4b3f-be6a-109653b2c34d",
        "value": "FAIL"
      }
    ]
  }
]

Code Samples

curl -X POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/insertion  \ 
-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/insertion  \ 
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/insertion" \
 --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/insertion', 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.