Insert samples

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2029-01-31.

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 /platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/insertion

Required OAuth Scopes

graph:write

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
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
body	body	MatrixSamples	true	Details 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

curl -X POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/insertion \
    -H 'Content-Type: application/json' \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http POST https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples/insertion \
    X-Version:2022-01-01 \
    Content-Type:application/json \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

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 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  '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/insertion', headers = headers)

print(r.headers['Location'])