Create a new matrix

Description

Create a new empty matrix. The id field for the matrix and its columns should be left blank; this will be populated by the endpoint.

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

🚧
Required OAuth Scopes:
graph:write

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
body	body	Matrix	true	The properties of the matrix to create

Body parameter example

{
  "dataColumns": [
    {
      "externalId": "TA05",
      "name": "PO Number"
    },
    {
      "externalId": "TA06",
      "name": "Amount"
    }
  ],
  "name": "Purchase Orders",
  "resultColumns": [
    {
      "externalId": "TA07",
      "name": "A"
    }
  ]
}

Code Samples

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

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

wget --method=POST "https://api.app.wdesk.com/platform/v1/testForms/{testFormId}/testPhases/{testPhaseId}/matrices" \
 --output-document -  \ 
 --header 'Content-Type: application/json' \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'

import requests
headers = {
  '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', headers = headers)

print(r.json())

Returns

201 - Created

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",
      "externalId": "TA05"
    },
    {
      "id": "fbd818ec-4fd1-42ad-9112-3c80e71dc2dc",
      "name": "Amount",
      "externalId": "TA06"
    }
  ],
  "resultColumns": [
    {
      "id": "d795d7a3-e7f7-4b3f-be6a-109653b2c34d",
      "name": "A",
      "externalId": "TA07"
    }
  ]
}