Retrieve a list of matrices

Description

Returns a list of matrices.

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

🚧
Required OAuth Scopes:
graph:read

Parameters

Parameter	In	Type	Required	Description
testFormId	path	string	true	The unique identifier of the test form
testPhaseId	path	string	true	The unique identifier of the test phase
$expand	query	string	false	Returns related resources inline with the main resource

Expand Options

Expands Options Supported
`samples`, `samples.attachments`, `attachments`

Code Samples

curl -X GET https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'

http GET https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"

wget --method=GET "https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices" \
 --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', headers = headers)

print(r.json())

Returns

200 - OK

Returns a JSON object with data and @nextLink properties. data contains a list of Matrix 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": "30053df2-75fa-4a1e-9e8c-0e18cdd66cd1",
      "name": "Purchase Orders",
      "dataColumns": [
        {
          "id": "d795d7a3-e7f7-4b3f-be6a-109653b2929b",
          "name": "PO Number"
        },
        {
          "id": "fbd818ec-4fd1-42ad-9112-3c80e71dc2dc",
          "name": "Amount"
        }
      ],
      "resultColumns": [
        {
          "id": "d795d7a3-e7f7-4b3f-be6a-109653b2c34d",
          "name": "A"
        }
      ]
    },
    {
      "id": "4f241ab3-cb2c-47e0-9a11-63156768494f",
      "name": "Back Orders",
      "dataColumns": [
        {
          "id": "21abeadf-d6c4-4e0e-bc3c-2e93eb2af3c8",
          "name": "PO Number"
        },
        {
          "id": "bbd4ff3e-1c0b-4656-bcb5-30297377fb01",
          "name": "Amount"
        }
      ],
      "resultColumns": [
        {
          "id": "ebf2ba9d-d2e7-461f-8d43-48fea0e3b567",
          "name": "A"
        }
      ]
    }
  ],
  "@nextLink": "{opaqueUrl}"
}