API Reference

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

Properties

NameTypeDescriptionRestrictions
fileNamestringThe filename of the graph attachment
idstringThe unique identifier of the graph attachmentread-only

Example

{
  "fileName": "signature.jpg",
  "id": "0a0da34f-bf3e-47fc-bc47-946ab14900b7"
}

GraphAttachmentExport

Properties

NameTypeDescriptionRestrictions
formatstringThe format to export the attachment to — currently, .PDF only

Enumerated Values

PropertyValue
formatpdf

Example

{
  "format": "pdf"
}

GraphAttachmentUpload

Properties

NameTypeDescriptionRestrictions
fileNamestringThe file name of the graph attachment

Example

{
  "fileName": "signature.jpg"
}

GraphAttachmentUploadResponse

Properties

NameTypeDescriptionRestrictions
uploadUrlstringThe 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 request is received.

Example

{
  "uploadUrl": "string"
}

Matrix

Properties

NameTypeDescriptionRestrictions
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]An array of the data columns in the matrix
idstringThe unique identifier of the matrixread-only
namestringThe 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"
    }
  ],
  "id": "30053df2-75fa-4a1e-9e8c-0e18cdd66cd1",
  "name": "Purchase Orders",
  "resultColumns": [
    {
      "externalId": "TA07",
      "id": "d795d7a3-e7f7-4b3f-be6a-109653b2c34d",
      "name": "A"
    }
  ]
}

MatrixColumn

Properties

NameTypeDescriptionRestrictions
externalIdstringA user defined external ID for the column
idstringThe unique ID of the matrix column
namestringThe name of the matrix column
testablebooleanWhether the column is testableread-only

Example

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

MatrixSample

Properties

NameTypeDescriptionRestrictions
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]An array of SampleCell values representing the values for each data column of the sample matrix's cells
idstringThe unique ID of the matrix sample
resultValues[SampleCell]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

Properties

NameTypeDescriptionRestrictions
[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

Properties

NameTypeDescriptionRestrictions
columnstringThe ID of the column associated with the cell's value
valuestringThe string value of the cell

Example

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

TestForm

Properties

NameTypeDescriptionRestrictions
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
idstringThe unique ID of the test form
namestringThe 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

Properties

NameTypeDescriptionRestrictions
formatstringThe format to export the test form to—currently, only .XLSX

Enumerated Values

PropertyValue
formatxlsx

Example

{
  "format": "xlsx"
}

TestPhase

Properties

NameTypeDescriptionRestrictions
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
idstringThe 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
namestringThe name of the test phase

Example

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