Test Definitions

List test definitions

Get a list of test definitions, optionally filtered by service it belongs to. 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.

get/v1/dataQuality/testDefinitions

Request

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

Query parameters

fieldsstring
Example:owners

Fields requested in the returned resource

limitinteger

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

beforestring

Returns list of test definitions before this cursor

afterstring

Returns list of test definitions after this cursor

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

Include all, deleted, or non-deleted entities.

entityType'TABLE' | 'COLUMN'

Filter by entityType.

testPlatform'OpenMetadata' | 'GreatExpectations' | 'dbt' | 'Deequ' | 'Soda' | 'Other'

Filter by a test platform

supportedDataType'NUMBER' | 'TINYINT' | 'SMALLINT' | 'INT' | 'BIGINT' | 'BYTEINT' | 'BYTES' | 'FLOAT' | 'DOUBLE' | 'DECIMAL' | 'NUMERIC' | 'TIMESTAMP' | 'TIMESTAMPZ' | 'TIME' | 'DATE' | 'DATETIME' | 'INTERVAL' | 'STRING' | 'MEDIUMTEXT' | 'TEXT' | 'CHAR' | 'LONG' | 'VARCHAR' | 'BOOLEAN' | 'BINARY' | 'VARBINARY' | 'ARRAY' | 'BLOB' | 'LONGBLOB' | 'MEDIUMBLOB' | 'MAP' | 'STRUCT' | 'UNION' | 'SET' | 'GEOGRAPHY' | 'ENUM' | 'JSON' | 'UUID' | 'VARIANT' | 'GEOMETRY' | 'BYTEA' | 'AGGREGATEFUNCTION' | 'ERROR' | 'FIXED' | 'RECORD' | 'NULL' | 'SUPER' | 'HLLSKETCH' | 'PG_LSN' | 'PG_SNAPSHOT' | 'TSQUERY' | 'TXID_SNAPSHOT' | 'XML' | 'MACADDR' | 'TSVECTOR' | 'UNKNOWN' | 'CIDR' | 'INET' | 'CLOB' | 'ROWID' | 'LOWCARDINALITY' | 'YEAR' | 'POINT' | 'POLYGON' | 'TUPLE' | 'SPATIAL' | 'TABLE' | 'NTEXT' | 'IMAGE' | 'IPV4' | 'IPV6' | 'DATETIMERANGE' | 'HLL' | 'LARGEINT' | 'QUANTILE_STATE' | 'AGG_STATE' | 'BITMAP' | 'UINT' | 'BIT' | 'MONEY' | 'MEASURE HIDDEN' | 'MEASURE VISIBLE' | 'MEASURE' | 'KPI' | 'HEIRARCHY' | 'HIERARCHYID'

Filter tests definition by supported data type

supportedServicestring

Filter test definitions by supported service. Returns test definitions that either have an empty supportedServices list (supporting all services) or include the specified service.

enabledboolean

Filter by enabled status (true/false). If not specified, returns all test definitions.

Response

List of test definitions

warningsCountinteger

Changes

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