API Reference

Retrieve a list of samples

Description

Returns a list of samples.

GET /testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples

🚧

Required OAuth Scopes:

graph:read

Parameters

ParameterInTypeRequiredDescription
testFormIdpathstringtrueThe unique identifier of the test form
testPhaseIdpathstringtrueThe unique identifier of the test phase
matrixIdpathstringtrueThe unique identifier of the matrix
$expandquerystringfalseReturns related resources inline with the main resource

Expand Options

Expands Options Supported
attachments

Code Samples

curl -X GET https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http GET https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=GET "https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples" \
 --output-document -  \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices/{matrixId}/samples', headers = headers)

print(r.json())

Returns

200 - OK

Returns a JSON object with data and @nextLink properties. data contains a list of MatrixSample objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn't appear. If the request returns no results at all, data contains an empty array.

Example Responses


{
  "data": [
    {
      "id": "ce4a6c7f-15ad-445c-a76a-f457d53f667a",
      "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"
        }
      ]
    },
    {
      "id": "c4d64a06-f151-4d78-9618-3ba3b298ef7b",
      "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"
        }
      ]
    }
  ],
  "@nextLink": "{opaqueUrl}"
}