Skip to main content
GET
GET /v1/dataQuality/testDefinitions/{id}

Retrieve a Test Definition

Get a single test definition by its unique ID or name.

Get by ID

id
string
required
UUID of the test definition to retrieve.
fields
string
Comma-separated list of fields to include (e.g., owners).
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.

Get by Name

Use GET /v1/dataQuality/testDefinitions/name/{name} to retrieve by name.
name
string
required
Name of the test definition (e.g., columnValueLengthsToBeBetween).
fields
string
Comma-separated list of fields to include: owners.
include
string
default:"non-deleted"
Include all, deleted, or non-deleted entities.
GET /v1/dataQuality/testDefinitions/{id}

Returns

Returns a test definition object with all requested fields populated.

Response

id
string
Unique identifier for the test definition (UUID format).
name
string
Test definition name.
fullyQualifiedName
string
Fully qualified name (same as name for test definitions).
displayName
string
Human-readable display name.
description
string
Description of what the test validates.
entityType
string
Target entity type: TABLE or COLUMN.
testPlatforms
array
Supported test platforms.
supportedDataTypes
array
Data types this test can be applied to.
parameterDefinition
array
Parameters accepted by this test definition.
provider
string
Whether the definition is system (built-in) or user (custom).
version
number
Version number for the entity.
owners
array
List of owners. Only included when fields contains owners.

Error Handling