Last updated: July 22, 2025

Reference of all models used by DQOps REST API

This is a list of the models in DQOps REST API Python client broken down by individual controllers.

common

Class name	Description
CheckType	Enumeration of data quality check types: profiling, monitoring, partitioned.
CheckTimeScale	Enumeration of time scale of monitoring and partitioned data quality checks (daily, monthly, etc.)
FieldModel	Model of a single field that is used to edit a parameter value for a sensor or a rule. Describes the type of the field and the current value.
RuleParametersModel	Model that returns the form definition and the form data to edit parameters (thresholds) for a rule at a single severity level (low, medium, high).
CheckConfigurationModel	Model containing fundamental configuration of a single data quality check.
CheckListModel	Simplistic model that returns a single data quality check, its name and "configured" flag.
CheckContainerListModel	Simplistic model that returns the list of data quality checks, their names, categories and "configured" flag.
RuleThresholdsModel	Model that returns the form definition and the form data to edit a single rule with all three threshold levels (low, medium, high).
DefaultRuleSeverityLevel	Default rule severity levels. Matches the severity level name (warning - 1, alert - 2, fatal - 3) with a numeric level.
CronScheduleSpec	Cron job schedule specification.
CheckRunScheduleGroup	The run check scheduling group (profiling, daily checks, monthly checks, etc), which identifies the configuration of a schedule (cron expression) used schedule these checks on the job scheduler.
EffectiveScheduleLevelModel	Enumeration of possible levels at which a schedule can be configured.
EffectiveScheduleModel	Model of a configured schedule (on connection or table) or schedule override (on check). Describes the CRON expression and the time of the upcoming execution, as well as the duration until this time.
ScheduleEnabledStatusModel	Enumeration of possible ways a schedule can be configured.
CommentSpec	Comment entry. Comments are added when a change was made and the change should be recorded in a persisted format.
CommentsListSpec	List of comments.
CheckSearchFilters	Target data quality checks filter, identifies which checks on which tables and columns should be executed.
CheckTargetModel	Enumeration of possible targets for check model request result.
SimilarCheckModel	Describes a single check that is similar to other checks in other check types.
CheckModel	Model that returns the form definition and the form data to edit a single data quality check.
QualityCategoryModel	Model that returns the form definition and the form data to edit all checks within a single category.
CheckContainerModel	Model that returns the form definition and the form data to edit all data quality checks divided by categories.
CheckContainerTypeModel	Model identifying the check type and timescale of checks belonging to a container.
CheckTemplate	Model depicting a named data quality check that can potentially be enabled, regardless to its position in hierarchy tree.
PhysicalTableName	Physical table name that is a combination of a schema name and a physical table name (without any quoting or escaping).
RuleSeverityLevel	Rule severity levels. Matches the severity level name (warning - 1, alert - 2, fatal - 3) with a numeric level.
CheckResultStatus	Enumeration of check execution statuses. It is the highest severity or an error if the sensor cannot be executed due to a configuration issue.
CheckCurrentDataQualityStatusModel	The most recent data quality status for a single data quality check. If data grouping is enabled, this model will return the highest data quality issue status from all data quality results for all data groups.
DimensionCurrentDataQualityStatusModel	A model that describes the current data quality status for a single data quality dimension.
ColumnCurrentDataQualityStatusModel	The column validity status. It is a summary of the results of the most recently executed data quality checks on the column.
ColumnListModel	Column list model that returns the basic fields from a column specification, excluding nested nodes like a list of activated checks.
ProviderType	Data source provider type (dialect type). We will use lower case names to avoid issues with parsing, even if the enum names are not named following the Java naming convention.
ConnectionModel	Connection model returned by the rest api that is limited only to the basic fields, excluding nested nodes.
DqoQueueJobId	Identifies a single job.
HistogramDailyIssuesCount	A model that stores a daily number of incidents.
IssueHistogramModel	Model that returns histograms of the data quality issue occurrences related to a data quality incident or a table. The dates in the daily histogram are using the default timezone of the DQOps server.
ProfilingTimePeriodTruncation	The time period for profiling checks (millisecond, daily, monthly, weekly, hourly). The default profiling check stores one value per month. When profiling checks is re-executed during the month, the previous profiling checks value is overwritten and only the most recent value is stored.
TableListModel	Table list model returned by the rest api that is limited only to the basic fields, excluding nested nodes.

check_results

Class name	Description
CheckResultsDetailedLoadMode	The mode of loading a list of detailed check results: the most recent values for each data group, or all results of the first group.
CheckResultsListModel	Check detailed results. Returned in the context of a single data group, with a supplied list of other data groups.
TableCurrentDataQualityStatusModel	The table validity status. It is a summary of the results of the most recently executed data quality checks on the table.

check_results_overview

Class name	Description
Instant
CheckResultsOverviewDataModel	Check recent results overview. Returns the highest severity for the last several runs.

checks

Class name	Description
CheckDefinitionListModel	Check list model that is returned by the REST API.
CheckDefinitionFolderModel	Check list folder model that is returned by the REST API.
CheckDefinitionModel	Check model that is returned by the REST API. Describes a single unique data quality check.

column_quality_policies

Class name	Description
TargetColumnPatternSpec	The configuration of a column pattern to match default column checks. Includes also the pattern for the target table.
ColumnQualityPolicyListModel	The listing model of column-level default check patterns that is returned by the REST API.
ColumnMonitoringCheckCategoriesSpec	Container of column level monitoring, divided by the time window (daily, monthly, etc.)
ColumnPartitionedCheckCategoriesSpec	Container of column level partitioned checks, divided by the time window (daily, monthly, etc.)
ColumnQualityPolicySpec	The default configuration of column-level data quality checks that are enabled as data observability checks to analyze basic measures and detect anomalies on columns. This configuration serves as a data quality policy that defines the data quality checks that are verified on matching columns.
ColumnQualityPolicyModel	Default column-level checks pattern model that is returned by the REST API. Describes a configuration of data quality checks for a named pattern. DQOps applies these checks on columns that match the filter.

columns

Class name	Description
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.
CustomCheckSpecMap	Dictionary of custom checks indexed by a check name.
ColumnDailyMonitoringCheckCategoriesSpec	Container of column level daily monitoring checks. Contains categories of daily monitoring checks.
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.
ColumnDailyPartitionedCheckCategoriesSpec	Container of data quality partitioned checks on a column level that are checking numeric values at a daily level.
ColumnModel	Table model that returns the specification of a single column in the REST Api.
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.
ColumnMonthlyMonitoringCheckCategoriesSpec	Container of column level monthly monitoring checks. Contains categories of monthly monitoring checks.
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.
ColumnMonthlyPartitionedCheckCategoriesSpec	Container of data quality partitioned checks on a column level that are checking numeric values at a monthly level.
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.
ColumnProfilingCheckCategoriesSpec	Container of column level, preconfigured profiling checks.
ColumnStatisticsModel	Column model that returns the basic fields from a column specification and a summary of the most recent statistics collection.
TableColumnsStatisticsModel	Model that returns a summary of the column statistics (the basic profiling results) for a single table, showing statistics for all columns.

connections

Class name	Description
AllChecksPatchParameters
BulkCheckDeactivateParameters
ConnectionSpecificationModel	Connection model returned by the rest api.

dashboards

Class name	Description
DashboardSpec	Description of a single dashboard that is available in the platform.
AuthenticatedDashboardModel	Model that describes a single authenticated dashboard.
DashboardListSpec	List of dashboards.
DashboardsFolderListSpec	List of dashboard folders.
DashboardsFolderSpec	Description of a folder with multiple dashboards or other folders.

data_domains

Class name	Description
LocalDataDomainModel	Model that describes a local data domain. It is also used to create new data domains.

data_grouping_configurations

Class name	Description
DataGroupingConfigurationListModel	Basic model for data grouping configuration on a table, returned by the rest api.
DataGroupingConfigurationModel	Model of data grouping configuration on a table returned by the rest api, including all configuration information.
DataGroupingConfigurationTrimmedModel	Data grouping on a table model with trimmed access path.

data_lineage

Class name	Description
DomainConnectionTableKey	A key object that identifies every table. These keys are used in a cache to store the most recent table quality status for each table or a data lineage cache.
TableLineageFlowModel	Table lineage flow model that describes the data flow from one table to another table, and the data quality status of the source table.
TableLineageModel	The table lineage model that returns all upstream tables, downstream tables, or both.
SourceColumnsSetSpec	A collection of unique names of source columns from which the current column receives data. This information is used to track column-level data lineage.
ColumnLineageSourceSpec	Describes the list of source columns for a column in the current table.
ColumnLineageSourceSpecMap	Dictionary of mapping of source columns to the columns in the current table. The keys in this dictionary are the column names in the current table.
TableLineageSourceSpec	Data lineage specification for a table to identify a source table of the current table where this object is stored.
TableLineageTableListModel	Data lineage model that describes one source or target table of the current table.

data_sources

Class name	Description
ConnectionTestStatus	Tabular output format for printing the tabular results.
ConnectionTestModel	Connection test status result model returned from REST API. Describes the status of testing a connection (opening a connection to verify if it usable, credentials are approved and the access was granted by the tested data source).
RemoteTableListModel	Remote table list model that is returned when a data source is introspected to retrieve the list of tables available in a data source.
SchemaRemoteModel	Schema model returned from REST API. Describes a schema on the source database with established connection.

dictionaries

Class name	Description
DataDictionaryListModel	Data dictionary CSV file list model with the basic information about the dictionary.
DataDictionaryModel	Data dictionary CSV full model used to create and update the dictionary file. Contains the content of the CSV file as a text field.

environment

Class name	Description
DqoSettingsModel	REST API model that returns a key/value list of all DQOps configuration properties.
DqoUserRole	DQOps user role within a data domain or a whole account level.
DqoUserProfileModel	The model that describes the current user and his access rights.

error_samples

Class name	Description
ErrorSampleResultDataType	Enumeration of data types that were detected as the error sample collector result.
TimePeriodGradient	Time series gradient type (daily, monthly, quarterly, monthly, weekly, hourly).
ErrorSampleEntryModel	Detailed error samples captured for a single check. Represent one row in the error_samples table.
ErrorSamplesListModel	List of error samples for a single check. Returned in the context of a single data group, with a supplied list of other data groups.

errors

Class name	Description
ErrorEntryModel	Detailed error statuses for a single check. Represent one row in the errors table.
ErrorsListModel	Error detailed statuses. Returned in the context of a single data group, with a supplied list of other data groups.

filtered_notifications_configurations

Class name	Description
FilteredNotificationModel	Named filtered notification model that represents a single entry of the FilteredNotificationSpecMap.

incidents

Class name	Description
CheckResultEntryModel	Detailed results for a single check. Represent one row in the check results table.
CheckResultSortOrder	Enumeration of columns names on a {@link CheckResultEntryModel CheckResultEntryModel} that can be sorted.
IncidentStatus	Enumeration of the statuses used in the "status" field of the "incidents" table.
IncidentFilteredNotificationLocation	Enumeration that says where a filtered notification for an incident is defined. Is it defined on a connection level, or on the global level.
IncidentModel	Data quality incident model shown on an incident details screen.
IncidentSortOrder	Incident sort order columns.
IncidentsPerConnectionModel	Simple model that returns a list of connections and a number of open (new) data quality incidents per connection.
SortDirection	REST api model sort direction.
TopIncidentGrouping	Enumeration of groupings for incidents.
IncidentCountsModel	Stores numbers of incidents over a specific time period.
IncidentSeverityLevelCountsModel	Contains the counts for each of severity level.
TopIncidentsModel	Summary model with the most recent incidents grouped by one attribute (data quality dimension, data quality check category, etc).

jobs

Class name	Description
TimeWindowFilterParameters
ErrorSamplesDataScope	Enumeration of possible error samples collection scopes. "table" - a whole table is analyzed for error samples, "data_groupings" - error samples are collected for each data grouping.
ErrorSamplerResult
CollectErrorSamplesParameters
DqoJobStatus	Job status of a job on the queue.
CollectErrorSamplesResult
CollectStatisticsResult
CollectStatisticsQueueJobResult
DeleteStoredDataQueueJobParameters	Parameters for the "delete stored data queue job that deletes data from parquet files stored in DQOps user home's .data* directory.
DqoRoot	DQOps root folders in the dqo use home that may be replicated to a remote file system (uploaded to DQOps Cloud or any other cloud). It is also used as a lock scope.
ParquetPartitionId	Identifies a single partition for hive partitioned tables stored as parquet files.
DataDeleteResultPartition	Results of the "data delete" job for the monthly partition.
DeleteStoredDataResult	Compiled results of the "data delete".
DeleteStoredDataQueueJobResult	Object returned from the operation that queues a "delete stored data" job. The result contains the job id that was started and optionally can also contain a dictionary of partitions that were cleared or deleted if the operation was started with wait=true parameter to wait for the "delete stored data" job to finish.
DqoJobType	Job type that identifies a job by type.
FileSynchronizationDirection	Data synchronization direction between a local DQOps Home and DQOps Cloud data quality data warehouse.
SynchronizeRootFolderParameters	Parameter object for starting a file synchronization job. Identifies the folder and direction that should be synchronized.
SynchronizeRootFolderDqoQueueJobParameters	Parameters object for a job that synchronizes one folder with DQOps Cloud.
SynchronizeMultipleFoldersDqoQueueJobParameters	Simple object for starting multiple folder synchronization jobs with the same configuration.
RunChecksTarget
RunChecksResult
RunChecksParameters
RunChecksOnTableParameters
StatisticsCollectorTarget
StatisticsCollectorSearchFilters	Hierarchy node search filters for finding enabled statistics collectors (basic profilers) to be started.
StatisticsDataScope	Enumeration of possible statistics scopes. "table" - a whole table was profiled, "data_groupings" - groups of rows were profiled.
CollectStatisticsQueueJobParameters
CollectStatisticsOnTableQueueJobParameters
CollectErrorSamplesOnTableParameters
ImportSchemaQueueJobParameters	Parameters for the {@link ImportSchemaQueueJob ImportSchemaQueueJob} job that imports tables from a database.
ImportTablesQueueJobParameters	Parameters for the {@link ImportTablesQueueJob ImportTablesQueueJob} job that imports selected tables from the source database.
RepairStoredDataQueueJobParameters	Parameters for the {@link RepairStoredDataQueueJob RepairStoredDataQueueJob} job that repairs data stored in user's ".data" directory.
DqoJobEntryParametersModel	Model object returned to UI that has typed fields for each supported job parameter type.
DqoJobHistoryEntryModel	Model of a single job that was scheduled or has finished. It is stored in the job monitoring service on the history list.
DqoJobChangeModel	Describes a change to the job status or the job queue (such as a new job was added).
FolderSynchronizationStatus	Enumeration of statuses identifying the synchronization status for each folder that can be synchronized with the DQOps cloud.
CloudSynchronizationFoldersStatusModel	Model that describes the current synchronization status for each folder.
DqoJobQueueIncrementalSnapshotModel	Job history snapshot model that returns only changes after a given change sequence.
DqoJobQueueInitialSnapshotModel	Returns the current snapshot of running jobs.
ImportTablesResult	Result object from the {@link ImportTablesQueueJob ImportTablesQueueJob} table import job that returns list of tables that have been imported.
ImportTablesQueueJobResult	Object returned from the operation that queues a "import tables" job. The result contains the job id that was started and optionally can also contain the result of importing tables if the operation was started with wait=true parameter to wait for the "import tables" job to finish.
RunChecksQueueJobResult
SpringErrorPayload	Object mapped to the default spring error payload (key/values).
SynchronizeMultipleFoldersQueueJobResult	Object returned from the operation that queues a "synchronize multiple folders" job. The result contains the job id that was started and optionally can also contain the job finish status if the operation was started with wait=true parameter to wait for the "synchronize multiple folders" job to finish.

labels

Class name	Description
LabelModel	Label model that is returned by the REST API. A label is a tag that was assigned to a data source, table, column or a single check. Labels play the role of a business glossary.

log_shipping

Class name	Description
ExternalLogEntry	External log entry that would be logged on the server.

rule_mining

Class name	Description
TargetRuleSeverityLevel	Default rule severity levels. Matches the severity level name (warning - 1, alert - 2, fatal - 3) with a numeric level.
CheckMiningParametersModel	Data quality check rule mining parameters. Configure what type of checks should be configured.
CheckMiningProposalModel	Model that has a proposed configuration of checks on a table and its columns generated by a data quality check mining service.

rules

Class name	Description
RuleListModel	Rule list model that is returned by the REST API.
RuleFolderModel	Rule folder model that is returned by the REST API.
RuleRunnerType	Implementation mode for a rule runner (rule implementation).
RuleTimeWindowMode	Rule historic data mode. A rule may evaluate only the current sensor readout (current_value) or use historic values.
ParameterDefinitionsListSpec	List of parameter definitions - the parameters for custom sensors or custom rules.
RuleModel	Rule model that is returned by the REST API. Describes a single unique rule name.

schemas

Class name	Description
CheckTarget	Enumeration of targets where the check is applied. It is one of "table" or "column".
SchemaModel	Schema model that is returned by the REST API. Describes a single unique schema name.

search

Class name	Description
DataTypeCategory	Enumeration of common data type categories of data types. The providers will use this information to answer which of their native data types matches a category. Some sensors (and profilers) cannot operate on some data types.

sensor_readouts

Class name	Description
SensorReadoutEntryModel	Detailed results for a single sensor. Represent one row in the sensor readouts table.
SensorReadoutsListModel	Sensor readout detailed results. Returned in the context of a single data group, with a supplied list of other data groups.

sensors

Class name	Description
ProviderSensorListModel	Provider sensor list model that is returned by the REST API.
SensorListModel	Sensor list model that is returned by the REST API.
SensorFolderModel	Sensor folder model that is returned by the REST API.
ProviderSensorModel	Provider sensor model returned from REST API.
SensorModel	Sensor model returned from REST API.

shared_credentials

Class name	Description
CredentialType	Credential type - a text credential or a binary credential that must be updated as a base64 value.
SharedCredentialListModel	Shared credentials list model with the basic information about the credential.
SharedCredentialModel	Shared credentials full model used to create and update the credential. Contains one of two forms of the credential's value: a text or a base64 binary value.

table_comparison_results

Class name	Description
ComparisonCheckResultModel	The table comparison check result model for the most recent data comparison run. Identifies the check name and the number of data groupings that passed or failed the comparison.
TableComparisonColumnResultsModel	The table comparison column results model with the information about the most recent table comparison relating to a single compared column.
TableComparisonResultsModel	The table comparison results model with the summary information about the most recent table comparison that was performed.

table_comparisons

Class name	Description
TableComparisonGroupingColumnPairModel	Model that identifies a pair of column names used for grouping the data on both the compared table and the reference table. The groups are then matched (joined) by DQOps to compare aggregated results.
TableComparisonConfigurationModel	Model that contains the basic information about a table comparison configuration that specifies how the current table can be compared with another table that is a source of truth for comparison.
CompareThresholdsModel	Model with the custom compare threshold levels for raising data quality issues at different severity levels when the difference between the compared (tested) table and the reference table (the source of truth) exceed given thresholds as a percentage of difference between the actual value and the expected value from the reference table.
ColumnComparisonModel	The column to column comparison model used to select which measures (min, max, sum, mean, null count, not nul count) are compared for this column between the compared (tested) column and the reference column from the reference table.
TableComparisonModel	Model that contains the all editable information about a table-to-table comparison defined on a compared table.

table_quality_policies

Class name	Description
TargetTablePatternSpec	The configuration of a table pattern to match default table checks.
TableQualityPolicyListModel	The listing model of table-level default check patterns that is returned by the REST API.
TableMonitoringCheckCategoriesSpec	Container of table level monitoring, divided by the time window (daily, monthly, etc.)
TablePartitionedCheckCategoriesSpec	Container of table level partitioned checks, divided by the time window (daily, monthly, etc.)
TableQualityPolicySpec	The default configuration of table-level data quality checks that are enabled as data observability checks to analyze basic measures and detect anomalies on tables. This configuration serves as a data quality policy that defines the data quality checks that are verified on matching tables.
TableQualityPolicyModel	Default table-level checks pattern model that is returned by the REST API. Describes a configuration of data quality checks for a named pattern. DQOps applies these checks on tables that match the filter.

tables

Class name	Description
SimilarTableModel	Model that describes a table that is similar to a reference table. Similar tables are used to build the data lineage graph.
TableComparisonDailyMonitoringChecksSpecMap	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 the daily monitoring comparison checks for each configured reference table.
CustomCheckSpecMap	Dictionary of custom checks indexed by a check name.
TableDailyMonitoringCheckCategoriesSpec	Container of table level daily monitoring. Contains categories of daily monitoring.
TableComparisonDailyPartitionedChecksSpecMap	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 the daily partitioned comparison checks for each configured reference table.
TableDailyPartitionedCheckCategoriesSpec	Container of table level daily partitioned checks. Contains categories of daily partitioned checks.
TableModel	Full table model that returns the specification of a single table in the REST Api.
TableComparisonMonthlyMonitoringChecksSpecMap	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 the monthly monitoring comparison checks for each configured reference table.
TableMonthlyMonitoringCheckCategoriesSpec	Container of table level monthly monitoring checks. Contains categories of monthly monitoring checks.
TableComparisonMonthlyPartitionedChecksSpecMap	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 the monthly partitioned comparison checks for each configured reference table.
TableMonthlyPartitionedCheckCategoriesSpec	Container of table level monthly partitioned checks. Contains categories of monthly partitioned checks.
TablePartitioningModel	Rest model that returns the configuration of table partitioning information.
TableComparisonProfilingChecksSpecMap	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.
TableProfilingCheckCategoriesSpec	Container of table level checks that are activated on a table level.
TableProfilingSetupStatusModel	Table status model that identifies which type of information is already collected, such as data quality checks are configured, or statistics collected. DQOps user interface uses this information to activate red borders to highlight tabs in the user interface that must be clicked to continue profiling the table.
TableStatisticsModel	Model that returns a summary of the table level statistics (the basic profiling results).

users

Class name	Description
DqoUserRolesModel	DQOps user model - identifies a user in a multi-user DQOps deployment and the user's roles.