Test Cases

List test cases

Get a list of test. Use fields parameter to get only necessary fields. Use cursor-based pagination to limit the number entries in the list using limit and before or after 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

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/dataQuality/testCases
  • 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)

beforestring

Returns list of tests before this cursor

afterstring

Returns list of tests after this cursor

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

Return list of tests by entity link

columnNamestring
Example:{columnName}

Return list of tests by column names

entityFQNstring
Example:{serviceName}.{databaseName}.{schemaName}.{tableName}.{columnName}

Return list of tests by entity FQN

testSuiteIdstring uuid

Returns list of tests filtered by the testSuite id

includeAllTestsboolean

Include all the tests at the entity level

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

Include all, deleted, or non-deleted entities.

testCaseStatus'Success' | 'Failed' | 'Aborted' | 'Queued'

Filter test case by status

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

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

createdBystring

Filter test cases by the user who created them

Response

List of test definitions

warningsCountinteger

Changes

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