Last updated: July 22, 2025
DQOps REST API columns models reference
The references of all objects used by columns REST API operations are listed below.
ColumnComparisonDailyMonitoringChecksSpecMap
Container of comparison checks for each defined data comparison. The name of the key in this dictionary must match a name of a table comparison that is defined on the parent table. Contains configuration of column level comparison checks. Each column level check container also defines the name of the reference column name to which we are comparing.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
self |
Dict[string, ColumnComparisonDailyMonitoringChecksSpec] |
CustomCheckSpecMap
Dictionary of custom checks indexed by a check name.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
self |
Dict[string, CustomCheckSpec] |
ColumnDailyMonitoringCheckCategoriesSpec
Container of column level daily monitoring checks. Contains categories of daily monitoring checks.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
nulls |
Daily monitoring checks of nulls in the column | ColumnNullsDailyMonitoringChecksSpec |
uniqueness |
Daily monitoring checks of uniqueness in the column | ColumnUniquenessDailyMonitoringChecksSpec |
accepted_values |
Configuration of accepted values checks on a column level | ColumnAcceptedValuesDailyMonitoringChecksSpec |
text |
Daily monitoring checks of text values in the column | ColumnTextDailyMonitoringChecksSpec |
whitespace |
Configuration of column level checks that detect blank and whitespace values | ColumnWhitespaceDailyMonitoringChecksSpec |
conversions |
Configuration of conversion testing checks on a column level. | ColumnConversionsDailyMonitoringChecksSpec |
patterns |
Daily monitoring checks of pattern matching on a column level | ColumnPatternsDailyMonitoringChecksSpec |
pii |
Daily monitoring checks of Personal Identifiable Information (PII) in the column | ColumnPiiDailyMonitoringChecksSpec |
numeric |
Daily monitoring checks of numeric values in the column | ColumnNumericDailyMonitoringChecksSpec |
anomaly |
Daily monitoring checks of anomalies in numeric columns | ColumnAnomalyDailyMonitoringChecksSpec |
datetime |
Daily monitoring checks of datetime in the column | ColumnDatetimeDailyMonitoringChecksSpec |
bool |
Daily monitoring checks of booleans in the column | ColumnBoolDailyMonitoringChecksSpec |
integrity |
Daily monitoring checks of integrity in the column | ColumnIntegrityDailyMonitoringChecksSpec |
accuracy |
Daily monitoring checks of accuracy in the column | ColumnAccuracyDailyMonitoringChecksSpec |
custom_sql |
Daily monitoring checks of custom SQL checks in the column | ColumnCustomSqlDailyMonitoringChecksSpec |
datatype |
Daily monitoring checks of datatype in the column | ColumnDatatypeDailyMonitoringChecksSpec |
schema |
Daily monitoring column schema checks | ColumnSchemaDailyMonitoringChecksSpec |
comparisons |
Dictionary of configuration of checks for table comparisons at a column level. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table. | ColumnComparisonDailyMonitoringChecksSpecMap |
custom |
Dictionary of custom checks. The keys are check names within this category. | CustomCheckSpecMap |
ColumnComparisonDailyPartitionedChecksSpecMap
Container of comparison checks for each defined data comparison. The name of the key in this dictionary must match a name of a table comparison that is defined on the parent table. Contains configuration of column level comparison checks. Each column level check container also defines the name of the reference column name to which we are comparing.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
self |
Dict[string, ColumnComparisonDailyPartitionedChecksSpec] |
ColumnDailyPartitionedCheckCategoriesSpec
Container of data quality partitioned checks on a column level that are checking numeric values at a daily level.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
nulls |
Daily partitioned checks of nulls in the column | ColumnNullsDailyPartitionedChecksSpec |
uniqueness |
Daily partitioned checks of uniqueness in the column | ColumnUniquenessDailyPartitionedChecksSpec |
accepted_values |
Configuration of accepted values checks on a column level | ColumnAcceptedValuesDailyPartitionedChecksSpec |
text |
Daily partitioned checks of text values in the column | ColumnTextDailyPartitionedChecksSpec |
whitespace |
Configuration of column level checks that detect blank and whitespace values | ColumnWhitespaceDailyPartitionedChecksSpec |
conversions |
Configuration of conversion testing checks on a column level. | ColumnConversionsDailyPartitionedChecksSpec |
patterns |
Daily partitioned pattern match checks on a column level | ColumnPatternsDailyPartitionedChecksSpec |
pii |
Daily partitioned checks of Personal Identifiable Information (PII) in the column | ColumnPiiDailyPartitionedChecksSpec |
numeric |
Daily partitioned checks of numeric values in the column | ColumnNumericDailyPartitionedChecksSpec |
anomaly |
Daily partitioned checks for anomalies in numeric columns | ColumnAnomalyDailyPartitionedChecksSpec |
datetime |
Daily partitioned checks of datetime in the column | ColumnDatetimeDailyPartitionedChecksSpec |
bool |
Daily partitioned checks for booleans in the column | ColumnBoolDailyPartitionedChecksSpec |
integrity |
Daily partitioned checks for integrity in the column | ColumnIntegrityDailyPartitionedChecksSpec |
custom_sql |
Daily partitioned checks using custom SQL expressions evaluated on the column | ColumnCustomSqlDailyPartitionedChecksSpec |
datatype |
Daily partitioned checks for datatype in the column | ColumnDatatypeDailyPartitionedChecksSpec |
comparisons |
Dictionary of configuration of checks for table comparisons at a column level. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table. | ColumnComparisonDailyPartitionedChecksSpecMap |
custom |
Dictionary of custom checks. The keys are check names within this category. | CustomCheckSpecMap |
ColumnModel
Table model that returns the specification of a single column in the REST Api.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
connection_name |
Connection name. | string |
table |
Physical table name including the schema and table names. | PhysicalTableName |
column_name |
Column name. | string |
column_hash |
Column hash that identifies the column using a unique hash code. | long |
spec |
Full column specification. | ColumnSpec |
can_edit |
Boolean flag that decides if the current user can update or delete this object. | boolean |
yaml_parsing_error |
Optional parsing error that was captured when parsing the YAML file. This field is null when the YAML file is valid. If an error was captured, this field returns the file parsing error message and the file location. | string |
ColumnComparisonMonthlyMonitoringChecksSpecMap
Container of comparison checks for each defined data comparison. The name of the key in this dictionary must match a name of a table comparison that is defined on the parent table. Contains configuration of column level comparison checks. Each column level check container also defines the name of the reference column name to which we are comparing.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
self |
Dict[string, ColumnComparisonMonthlyMonitoringChecksSpec] |
ColumnMonthlyMonitoringCheckCategoriesSpec
Container of column level monthly monitoring checks. Contains categories of monthly monitoring checks.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
nulls |
Monthly monitoring checks of nulls in the column | ColumnNullsMonthlyMonitoringChecksSpec |
uniqueness |
Monthly monitoring checks of uniqueness in the column | ColumnUniquenessMonthlyMonitoringChecksSpec |
accepted_values |
Configuration of accepted values checks on a column level | ColumnAcceptedValuesMonthlyMonitoringChecksSpec |
text |
Monthly monitoring checks of text values in the column | ColumnTextMonthlyMonitoringChecksSpec |
whitespace |
Configuration of column level checks that detect blank and whitespace values | ColumnWhitespaceMonthlyMonitoringChecksSpec |
conversions |
Configuration of conversion testing checks on a column level. | ColumnConversionsMonthlyMonitoringChecksSpec |
patterns |
Monthly monitoring checks of pattern matching on a column level | ColumnPatternsMonthlyMonitoringChecksSpec |
pii |
Monthly monitoring checks of Personal Identifiable Information (PII) in the column | ColumnPiiMonthlyMonitoringChecksSpec |
numeric |
Monthly monitoring checks of numeric values in the column | ColumnNumericMonthlyMonitoringChecksSpec |
datetime |
Monthly monitoring checks of datetime in the column | ColumnDatetimeMonthlyMonitoringChecksSpec |
bool |
Monthly monitoring checks of booleans in the column | ColumnBoolMonthlyMonitoringChecksSpec |
integrity |
Monthly monitoring checks of integrity in the column | ColumnIntegrityMonthlyMonitoringChecksSpec |
accuracy |
Monthly monitoring checks of accuracy in the column | ColumnAccuracyMonthlyMonitoringChecksSpec |
custom_sql |
Monthly monitoring checks of custom SQL checks in the column | ColumnCustomSqlMonthlyMonitoringChecksSpec |
datatype |
Monthly monitoring checks of datatype in the column | ColumnDatatypeMonthlyMonitoringChecksSpec |
schema |
Monthly monitoring column schema checks | ColumnSchemaMonthlyMonitoringChecksSpec |
comparisons |
Dictionary of configuration of checks for table comparisons at a column level. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table. | ColumnComparisonMonthlyMonitoringChecksSpecMap |
custom |
Dictionary of custom checks. The keys are check names within this category. | CustomCheckSpecMap |
ColumnComparisonMonthlyPartitionedChecksSpecMap
Container of comparison checks for each defined data comparison. The name of the key in this dictionary must match a name of a table comparison that is defined on the parent table. Contains configuration of column level comparison checks. Each column level check container also defines the name of the reference column name to which we are comparing.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
self |
Dict[string, ColumnComparisonMonthlyPartitionedChecksSpec] |
ColumnMonthlyPartitionedCheckCategoriesSpec
Container of data quality partitioned checks on a column level that are checking numeric values at a monthly level.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
nulls |
Monthly partitioned checks of nulls in the column | ColumnNullsMonthlyPartitionedChecksSpec |
uniqueness |
Monthly partitioned checks of uniqueness in the column | ColumnUniquenessMonthlyPartitionedChecksSpec |
accepted_values |
Configuration of accepted values checks on a column level | ColumnAcceptedValuesMonthlyPartitionedChecksSpec |
text |
Monthly partitioned checks of text values in the column | ColumnTextMonthlyPartitionedChecksSpec |
whitespace |
Configuration of column level checks that detect blank and whitespace values | ColumnWhitespaceMonthlyPartitionedChecksSpec |
conversions |
Configuration of conversion testing checks on a column level. | ColumnConversionsMonthlyPartitionedChecksSpec |
patterns |
Monthly partitioned pattern match checks on a column level | ColumnPatternsMonthlyPartitionedChecksSpec |
pii |
Monthly partitioned checks of Personal Identifiable Information (PII) in the column | ColumnPiiMonthlyPartitionedChecksSpec |
numeric |
Monthly partitioned checks of numeric values in the column | ColumnNumericMonthlyPartitionedChecksSpec |
datetime |
Monthly partitioned checks of datetime in the column | ColumnDatetimeMonthlyPartitionedChecksSpec |
bool |
Monthly partitioned checks for booleans in the column | ColumnBoolMonthlyPartitionedChecksSpec |
integrity |
Monthly partitioned checks for integrity in the column | ColumnIntegrityMonthlyPartitionedChecksSpec |
custom_sql |
Monthly partitioned checks using custom SQL expressions evaluated on the column | ColumnCustomSqlMonthlyPartitionedChecksSpec |
datatype |
Monthly partitioned checks for datatype in the column | ColumnDatatypeMonthlyPartitionedChecksSpec |
comparisons |
Dictionary of configuration of checks for table comparisons at a column level. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table. | ColumnComparisonMonthlyPartitionedChecksSpecMap |
custom |
Dictionary of custom checks. The keys are check names within this category. | CustomCheckSpecMap |
ColumnComparisonProfilingChecksSpecMap
Container of comparison checks for each defined data comparison. The name of the key in this dictionary must match a name of a table comparison that is defined on the parent table. Contains configuration of column level comparison checks. Each column level check container also defines the name of the reference column name to which we are comparing.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
self |
Dict[string, ColumnComparisonProfilingChecksSpec] |
ColumnProfilingCheckCategoriesSpec
Container of column level, preconfigured profiling checks.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
nulls |
Configuration of column level checks that detect null values. | ColumnNullsProfilingChecksSpec |
uniqueness |
Configuration of uniqueness checks on a column level. | ColumnUniquenessProfilingChecksSpec |
accepted_values |
Configuration of accepted values checks on a column level. | ColumnAcceptedValuesProfilingChecksSpec |
text |
Configuration of column level checks that verify text values. | ColumnTextProfilingChecksSpec |
whitespace |
Configuration of column level checks that detect blank and whitespace values. | ColumnWhitespaceProfilingChecksSpec |
conversions |
Configuration of conversion testing checks on a column level. | ColumnConversionsProfilingChecksSpec |
patterns |
Configuration of pattern match checks on a column level. | ColumnPatternsProfilingChecksSpec |
pii |
Configuration of Personal Identifiable Information (PII) checks on a column level. | ColumnPiiProfilingChecksSpec |
numeric |
Configuration of column level checks that verify numeric values. | ColumnNumericProfilingChecksSpec |
anomaly |
Configuration of anomaly checks on a column level that detect anomalies in numeric columns. | ColumnAnomalyProfilingChecksSpec |
datetime |
Configuration of datetime checks on a column level. | ColumnDatetimeProfilingChecksSpec |
bool |
Configuration of booleans checks on a column level. | ColumnBoolProfilingChecksSpec |
integrity |
Configuration of integrity checks on a column level. | ColumnIntegrityProfilingChecksSpec |
accuracy |
Configuration of accuracy checks on a column level. | ColumnAccuracyProfilingChecksSpec |
custom_sql |
Configuration of SQL checks that use custom SQL aggregated expressions and SQL conditions in data quality checks. | ColumnCustomSqlProfilingChecksSpec |
datatype |
Configuration of datatype checks on a column level. | ColumnDatatypeProfilingChecksSpec |
schema |
Configuration of schema checks on a column level. | ColumnSchemaProfilingChecksSpec |
comparisons |
Dictionary of configuration of checks for table comparisons at a column level. The key that identifies each comparison must match the name of a data comparison that is configured on the parent table. | ColumnComparisonProfilingChecksSpecMap |
custom |
Dictionary of custom checks. The keys are check names within this category. | CustomCheckSpecMap |
ColumnStatisticsModel
Column model that returns the basic fields from a column specification and a summary of the most recent statistics collection.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
connection_name |
Connection name. | string |
table |
Physical table name including the schema and table names. | PhysicalTableName |
column_name |
Column name. | string |
column_hash |
Column hash that identifies the column using a unique hash code. | long |
disabled |
Disables all data quality checks on the column. Data quality checks will not be executed. | boolean |
has_any_configured_checks |
True when the column has any checks configured. | boolean |
type_snapshot |
Column data type that was retrieved when the table metadata was imported. | ColumnTypeSnapshotSpec |
collect_column_statistics_job_template |
Configured parameters for the "collect statistics" job that should be pushed to the job queue in order to run all statistics collectors for this column | StatisticsCollectorSearchFilters |
can_collect_statistics |
Boolean flag that decides if the current user can collect statistics. | boolean |
TableColumnsStatisticsModel
Model that returns a summary of the column statistics (the basic profiling results) for a single table, showing statistics for all columns.
The structure of this object is described below
Property name | Description | Data type |
---|---|---|
connection_name |
Connection name. | string |
table |
Physical table name including the schema and table names. | PhysicalTableName |
collect_column_statistics_job_template |
Configured parameters for the "collect statistics" job that should be pushed to the job queue in order to run all statistics collectors for all columns on this table. | StatisticsCollectorSearchFilters |
can_collect_statistics |
Boolean flag that decides if the current user can collect statistics. | boolean |