Test Cases

Update test case

Create a TestCase, it it does not exist or update an existing TestCase.

put/v1/dataQuality/testCases

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/dataQuality/testCases
  • Auth: HTTP bearer

Request body

namestring required
descriptionstring
displayNamestring
testDefinitionstring required
entityLinkstring required
computePassedFailedRowCountboolean
useDynamicAssertionboolean
dimensionColumnsstring[]
topDimensionsinteger
extensionobject
dataProductsstring[]
domainsstring[]

Response

The updated testCase.

idstring uuid
namestring required
displayNamestring
fullyQualifiedNamestring
descriptionstring
entityLinkstring required
entityFQNstring
testCaseStatus'Success' | 'Failed' | 'Aborted' | 'Queued'
versionnumber double
createdBystring
updatedAtinteger
updatedBystring
hrefstring uri
deletedboolean
computePassedFailedRowCountboolean
autoCloseIncidentboolean
incidentIdstring uuid
inspectionQuerystring
useDynamicAssertionboolean
dimensionColumnsstring[]
topDimensionsinteger
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
provider'system' | 'user' | 'automation'
extensionobject
impersonatedBystring
sourceHashstring

Changes

No recorded changes to this operation across all 1 revision of this API.