Retrieve a single matrix

Description

Retrieves a matrix given its ID.

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

🚧
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
matrixId	path	string	true	The unique identifier of the matrix
$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/{matrixId}  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'

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

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

print(r.json())

Returns

200 - OK

Details about a matrix, including its name and ID.

Example Responses


{
  "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"
    }
  ]
}