Test Suites

List test suite using search service

Get a list of test suite 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 tests field to get the test cases linked to the test suite and/or use the summary field to get a summary of test case executions.

get/v1/dataQuality/testSuites/search/list

Request

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

Query parameters

fieldsstring
Example:owners,reviewers,tests,summary

Fields requested in the returned resource

limitinteger

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

offsetstring

Returns list of test suite after this offset (default = 0)

testSuiteTypestring
Example:executable

Returns executable or logical test suites. If omitted, returns all test suites.

includeEmptyTestSuitesboolean
Example:true

Include empty test suite in the response.

domainstring

Filter a test suite by domain.

fullyQualifiedNamestring

Filter a test suite by fully qualified name.

ownerstring

Filter test suites by owner.

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

Include all, deleted, or non-deleted entities.

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

qstring

search query term to use in list

queryStringstring

raw elasticsearch query to use in list

Response

List of test suites

warningsCountinteger

Changes

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