Test Cases

List test cases using search service

Get a list of test cases using the search service. Use fields parameter to get only necessary fields. Use offset/limit pagination to limit the number entries in the list using limit and offset query params.Use the testSuite field to get the Basic Test Suite linked to this test case or use the testSuites field to list test suites (Basic and Logical) linked.

get/v1/dataQuality/testCases/search/list

Request

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

Query parameters

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

Fields requested in the returned resource

limitinteger

Limit the number tests returned. (1 to 1000000, default = 10)

offsetstring

Returns list of tests after this offset

entityLinkstring
Example:<E#/{entityType}/{entityFQN}/{fieldName}>

Return list of tests by entity link

testSuiteIdstring

Returns list of tests filtered by a testSuite id

includeAllTestsboolean

Include all the tests at the entity level

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

Include all, deleted, or non-deleted entities.

testCaseStatusstring[]

Filter test case by status. Can be repeated or comma separated to filter on several statuses at once (e.g. testCaseStatus=Failed&testCaseStatus=Aborted), in which case test cases matching any of the statuses are returned. Values are matched case insensitively

testCaseType'column' | 'table' | 'all'

Filter for test case type (e.g. column, table, all)

testPlatformsstring

Filter for test case by source (e.g. OpenMetadata, dbt, etc.)

dataQualityDimensionstring

Filter for test case by data quality dimension (e.g. OpenMetadata, dbt, etc.)

startTimestampinteger

Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with endTimestamp

endTimestampinteger

Parameter used to filter (inclusive) the test cases by the last execution timestamp (in milliseconds). Must be used in conjunction with startTimestamp

sortFieldstring

Field used to sort the test cases listing

sortNestedPathstring

Set this field if your mapping is nested and you want to sort on a nested field

sortNestedModestring
Example:min,max,avg,sum,median

Set this field if your mapping is nested and you want to sort on a nested field

sortType'asc' | 'desc'

Sort type

includeFieldsstring

Return only required fields in the response

domainstring

domain filter to use in list

ownerstring

owner filter to use in list

tagsstring

tags filter to use in list

tierstring

tier filter to use in list

serviceNamestring

service filter to use in list

qstring

search query term to use in list

queryStringstring

raw elasticsearch query to use in list

createdBystring

Filter test cases by the user who created them

followedBystring

Filter test cases by entities followed by a user

columnNamestring
Example:{columnName}

Return list of tests by column names

dataProductFqnstring

data product filter to use in list

Response

List of test cases

warningsCountinteger

Changes

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