Test Forms

These endpoints are used to manage test forms, test phases, and matrices. They are also used to manage attachments on test phases, matrices, and samples.

GraphAttachment

Details about a graph attachment.

Properties

Name	Type	Description	Restrictions
fileName	string	The filename of the graph attachment
id	string	The unique identifier of the graph attachment	read-only

Example

{
  "fileName": "signature.jpg"
}

GraphAttachmentExport

Details about the attachment export including its format

Properties

Name	Type	Description	Restrictions
format	string	The format to export the attachment to — currently, .PDF only

Enumerated Values

Property	Value
format	pdf

Example

{
  "format": "pdf"
}

GraphAttachmentUpload

Details about a graph attachment upload

Properties

Name	Type	Description	Restrictions
fileName	string	The file name of the graph attachment

Example

{
  "fileName": "signature.jpg"
}

GraphAttachmentUploadResponse

Contains a pre-signed url that can be used to upload an attachment. The Location header also contains a url for an Operation that can be polled to find out if the upload was successful.

Properties

Name	Type	Description	Restrictions
uploadUrl	string	The URL to make a PUT request to, to upload the attachment. Include the file content of the attachment as the body of the request. This is a temporary URL; it should be used immediately when the response is received.

Example

{
  "uploadUrl": "string"
}

Matrix

Details about a matrix, including its name and ID.

Properties

Name	Type	Description	Restrictions
attachments	[GraphAttachment]	An optional array of partial information about the attachments on the matrix. To include in the response, provide the query string $expand=attachments.	read-only
dataColumns	[MatrixColumn]¦null	An array of the data columns in the matrix
id	string¦null	The unique identifier of the matrix	read-only
name	string	The name of the matrix
resultColumns	[MatrixColumn]	An array of the result columns in the matrix
samples	[MatrixSample]	An optional array of partial information about the samples on the matrix. To include in the response, provide the query parameter $expand=samples. To include the samples’ attachments, provide the parameter $expand=samples,samples.attachments.	read-only

Example

{
  "dataColumns": [
    {
      "externalId": "TA05",
      "id": "d795d7a3-e7f7-4b3f-be6a-109653b2929b",
      "name": "PO Number"
    },
    {
      "externalId": "TA06",
      "id": "fbd818ec-4fd1-42ad-9112-3c80e71dc2dc",
      "name": "Amount"
    }
  ],
  "name": "Purchase Orders",
  "resultColumns": [
    {
      "externalId": "TA07",
      "id": "d795d7a3-e7f7-4b3f-be6a-109653b2c34d",
      "name": "A"
    }
  ]
}

MatrixColumn

Details about a matrix column including its ID and name.

Properties

Name	Type	Description	Restrictions
externalId	string	A user defined external ID for the column
id	string¦null	The unique ID of the matrix column
name	string	The name of the matrix column
testable	boolean¦null	Whether the column is testable	read-only

Example

{
  "externalId": "TA05",
  "id": "fbd818ec-4fd1-42ad-9112-3c80e71dc2dc",
  "name": "PO #"
}

MatrixSample

This object represents a single row of a matrix.

Properties

Name	Type	Description	Restrictions
attachments	[GraphAttachment]	An optional array of partial information about the attachments on the matrix sample. To include in the response, provide the query parameter $expand=attachments.	read-only
dataValues	[SampleCell]¦null	An array of SampleCell values representing the values for each data column of the sample matrix’s cells
id	string	The unique ID of the matrix sample
resultValues	[SampleCell]¦null	An array of SampleCell values representing the values for each result cell in the sample matrix’s cells.

Example

{
  "dataValues": [
    {
      "column": "6d870cd1-7bbe-4b14-b85d-f152913b068c",
      "value": "23897"
    },
    {
      "column": "6301bea4-30be-4c24-9f15-287396f41d2c",
      "value": "385.3"
    }
  ],
  "id": "3dd42da0-3543-4e03-ac4a-2ddefebe27d6",
  "resultValues": [
    {
      "column": "674a9283-fd03-425d-bd62-0552263699e2",
      "value": "PASS"
    },
    {
      "column": "c7b812b4-70bb-47ed-a9bb-f56ca496c92f",
      "value": "FAIL"
    }
  ]
}

MatrixSamples

An array of matrix samples to submit at once

Properties

Name	Type	Description	Restrictions
anonymous	[MatrixSample]	An array of matrix samples to submit at once

Example

[
  {
    "dataValues": [
      {
        "column": "6d870cd1-7bbe-4b14-b85d-f152913b068c",
        "value": "23897"
      },
      {
        "column": "6301bea4-30be-4c24-9f15-287396f41d2c",
        "value": "385.3"
      }
    ],
    "id": "3dd42da0-3543-4e03-ac4a-2ddefebe27d6",
    "resultValues": [
      {
        "column": "674a9283-fd03-425d-bd62-0552263699e2",
        "value": "PASS"
      },
      {
        "column": "c7b812b4-70bb-47ed-a9bb-f56ca496c92f",
        "value": "FAIL"
      }
    ]
  }
]

SampleCell

Represents a single cell in a matrix

Properties

Name	Type	Description	Restrictions
column	string	The ID of the column associated with the cell’s value
value	string	The string value of the cell

Example

{
  "column": "235cdb36-f93d-4f15-bac9-1c3a52c2aefa",
  "value": "304.45"
}

TestForm

Describes details of a test form including its ID, name, and test phases.

Properties

Name	Type	Description	Restrictions
attachments	[GraphAttachment]	An optional array of partial information about the attachments on the test form. To include in the response, provide the query parameter $expand=attachments.	read-only
id	string	The unique ID of the test form
name	string	The name of the test form
testPhases	[TestPhase]	An optional array of partial information about the phases on the test form. To include in the response, provide the query parameter $expand=testPhases. To include the phases’ matrix digests, provide the parameter $expand=testPhases,testPhases.matrices.	read-only

Example

{
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "name": "Process Improvement"
}

TestFormExport

Describes parameters for exporting a test form.

Properties

Name	Type	Description	Restrictions
format	string	The format to export the test form to—currently, only .XLSX

Enumerated Values

Property	Value
format	xlsx

Example

{
  "format": "xlsx"
}

TestFormsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of TestForm 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.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	The pagination link for next set of results
data	[TestForm]	A list of Matrix objects	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "124efa2a142f472ba1ceab34ed18915f",
      "name": "Process Improvement"
    }
  ]
}

TestPhase

Describes details of a test phase, including its ID and name

Properties

Name	Type	Description	Restrictions
attachments	[GraphAttachment]	An optional array of partial information about the attachments on the test phase. To include in the response, provide the query string $expand=attachments.	read-only
id	string	The unique ID of the test phase
matrices	[Matrix]	An optional array of partial information about the matrices on the test phase. To include in the response, provide the query string, $expand=matrices.	read-only
name	string	The name of the test phase

Example

{
  "id": "bac770b8-1673-11ec-9621-0242ac130002",
  "name": "Walkthrough"
}

TestPhasesListResult

Returns a JSON object with data and @nextLink properties. data contains a list of TestPhase 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.

Properties

Name	Type	Description	Restrictions
@nextLink	string¦null	The pagination link for next set of results
data	[TestPhase]	A list of TestPhase objects	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "id": "bac770b8-1673-11ec-9621-0242ac130002",
      "name": "Walkthrough"
    }
  ]
}