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

string
required
UUID of the test definition to retrieve.
string
Comma-separated list of fields to include (e.g., owners).
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.
string
required
Name of the test definition (e.g., columnValueLengthsToBeBetween).
string
Comma-separated list of fields to include: owners.
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

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

Error Handling