Audits

Endpoints for working with audits

Audit

Properties

Name	Type	Description	Restrictions
archived	boolean	Whether or not the audit is archived
attachments	[GraphAttachment]	An optional array of partial information about the attachments on the audit	read-only
id	string	Resource id of the audit
name	string	Name of the audit
procedures	[allOf]	An optional array of information about the procedures on the matrix	read-only

Example

{
  "archived": true,
  "attachments": [
    {
      "fileName": "signature.jpg"
    }
  ],
  "id": "124efa2a142f472ba1ceab34ed18915f",
  "name": "Process Improvement",
  "procedures": [
    {
      "attachments": [
        {
          "fileName": "signature.jpg"
        }
      ],
      "groupName": "“Group A Responsibilities”",
      "id": "a8b3adb687644b27fafcb3a9875f0f0d_13",
      "matrices": [
        {
          "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"
            }
          ]
        }
      ],
      "name": "Procedure 1.1",
      "order": 2,
      "phaseName": "“Planning”"
    }
  ]
}

AuditExport

Describes parameters for exporting an audit.

Properties

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

Enumerated Values

Property	Value
format	xlsx

Example

{
  "format": "xlsx"
}

AuditsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Audit 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	Pagination link for next set of results
data	[Audit]		required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "archived": true,
      "attachments": [
        {
          "fileName": "signature.jpg"
        }
      ],
      "id": "124efa2a142f472ba1ceab34ed18915f",
      "name": "Process Improvement",
      "procedures": [
        {
          "attachments": [
            {
              "fileName": "signature.jpg"
            }
          ],
          "groupName": "“Group A Responsibilities”",
          "id": "a8b3adb687644b27fafcb3a9875f0f0d_13",
          "matrices": [
            {
              "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"
                }
              ]
            }
          ],
          "name": "Procedure 1.1",
          "order": 2,
          "phaseName": "“Planning”"
        }
      ]
    }
  ]
}

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

GraphAttachmentsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of GraphAttachment 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	The pagination link for next set of results
data	[GraphAttachment]	A list of GraphAttachment objects	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "fileName": "signature.jpg"
    }
  ]
}

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

MatricesListResult

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.

Properties

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

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "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"
        }
      ]
    }
  ]
}

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]	An array of the data columns in the matrix
id	string	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	The unique ID of the matrix column
name	string	The name of the matrix column
testable	boolean	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]	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]	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"
      }
    ]
  }
]

MatrixSamplesListResult

Returns a JSON object with data and @nextLink properties. data contains a list of MatrixSample 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	The pagination link for next set of results
data	[MatrixSample]	A list of MatrixSample objects	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "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"
        }
      ]
    }
  ]
}

Procedure

Properties

Name	Type	Description	Restrictions
attachments	[GraphAttachment]	An optional array of partial information about the attachments on the procedure	read-only
groupName	string	Name of the group that the procedure is organized within
id	string	Id of the procedure
matrices	[allOf]	An optional array of partial information about the matrices on the procedure	read-only
name	string	Name of the procedure
order	number	Order of the procedure within its group or phase
phaseName	string	Name of the phase that the procedure is organized within

Example

{
  "attachments": [
    {
      "fileName": "signature.jpg"
    }
  ],
  "groupName": "“Group A Responsibilities”",
  "id": "a8b3adb687644b27fafcb3a9875f0f0d_13",
  "matrices": [
    {
      "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"
        }
      ]
    }
  ],
  "name": "Procedure 1.1",
  "order": 2,
  "phaseName": "“Planning”"
}

ProceduresListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Procedure 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	Pagination link for next set of results
data	[Procedure]		required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "attachments": [
        {
          "fileName": "signature.jpg"
        }
      ],
      "groupName": "“Group A Responsibilities”",
      "id": "a8b3adb687644b27fafcb3a9875f0f0d_13",
      "matrices": [
        {
          "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"
            }
          ]
        }
      ],
      "name": "Procedure 1.1",
      "order": 2,
      "phaseName": "“Planning”"
    }
  ]
}

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