Test Definitions

Get a test definition by name

Get a test definition by name.

get/v1/dataQuality/testDefinitions/name/{name}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/dataQuality/testDefinitions/name/{name}
  • Auth: HTTP bearer

Path parameters

namestring required

Name of the test definition

Query parameters

fieldsstring
Example:owners

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

Response

The test definition

idstring uuid
namestring required
displayNamestring
fullyQualifiedNamestring
descriptionstring
entityType'TABLE' | 'COLUMN'
testPlatformsstring[] required
supportedDataTypesstring[]
dataQualityDimension'Completeness' | 'Accuracy' | 'Consistency' | 'Validity' | 'Uniqueness' | 'Integrity' | 'SQL' | 'NoDimension'
provider'system' | 'user' | 'automation'
versionnumber double
updatedAtinteger
updatedBystring
hrefstring uri
deletedboolean
supportsRowLevelPassedFailedboolean
supportsDynamicAssertionboolean
enabledboolean
supportedServicesstring[]
sqlExpressionstring
validatorClassstring
extensionobject
impersonatedBystring
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
sourceHashstring

Changes

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