Test Cases

Get a test case by Id

Get a TestCase by Id.

get/v1/dataQuality/testCases/{id}

Request

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

Path parameters

idstring uuid required

Id of the test case

Query parameters

fieldsstring
Example:owners,reviewers,entityStatus,testSuite,testDefinition,testSuites,incidentId,incidentStatus,domains,tags,followers,dataProducts

Fields requested in the returned resource

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

Include all, deleted, or non-deleted entities.

includeRelationsstring
Example:owners:non-deleted,followers:all

Per-relation include control. Format: field:value,field2:value2. Example: owners:non-deleted,followers:all. Valid values: all, deleted, non-deleted. If not specified for a field, uses the entity's include value.

Response

The TestCases

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.