Last updated: July 22, 2025
DQOps REST API data_lineage models reference
The references of all objects used by data_lineage REST API operations are listed below.
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.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
data_domain |
Data domain name. | string |
connection_name |
Connection name. | string |
physical_table_name |
Full table name, including the schema and the table names. | PhysicalTableName |
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.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
source_table |
The source table. | DomainConnectionTableKey |
target_table |
The target table. | DomainConnectionTableKey |
source_table_quality_status |
The current data quality status of the source table. | TableCurrentDataQualityStatusModel |
target_table_quality_status |
The current data quality status of the target table. | TableCurrentDataQualityStatusModel |
upstream_combined_quality_status |
The data quality status identified from the data quality status of all upstream tables and the target table. | TableCurrentDataQualityStatusModel |
row_count |
The row count of the source table. | long |
TableLineageModel
The table lineage model that returns all upstream tables, downstream tables, or both.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
relative_table |
The table for which the data lineage is generated. | DomainConnectionTableKey |
relative_table_cumulative_quality_status |
The data quality status of the reference table (in the middle of the data lineage) showing the highest severity problems detected on the reference table and all upstream tables from which some issues have come. | TableCurrentDataQualityStatusModel |
flows |
A list of data flows from source tables to direct target tables. Describes the data quality status of the source table. | List[TableLineageFlowModel] |
data_lineage_fully_loaded |
This flag tells if the data lineage was fully loaded. If any data flows are missing or the data quality status of some tables is missing, this flag will return false, which means that the data lineage must be loaded again. | boolean |
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.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
ColumnLineageSourceSpec
Describes the list of source columns for a column in the current table.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
source_columns |
A list of source columns from the source table name from which this column receives data. | SourceColumnsSetSpec |
properties |
A dictionary of mapping properties stored as a key/value dictionary. Data lineage synchronization tools that are importing data lineage mappings from external data lineage sources can use it to store mapping information. | Dict[string, string] |
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.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
self |
Dict[string, ColumnLineageSourceSpec] |
TableLineageSourceSpec
Data lineage specification for a table to identify a source table of the current table where this object is stored.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
source_connection |
The name of a source connection that is defined in DQOps and contains a source table from which the current table receives data. | string |
source_schema |
The name of a source schema within the source connection that contains a source table from which the current table receives data. | string |
source_table |
The name of a source table in the source schema from which the current table receives data. | string |
data_lineage_source_tool |
The name of a source tool from which this data lineage information was copied. This field should be filled when the data lineage was imported from another data catalog or a data lineage tracking platform. | string |
properties |
A dictionary of mapping properties stored as a key/value dictionary. Data lineage synchronization tools that are importing data lineage mappings from external data lineage sources can use it to store mapping information. | Dict[string, string] |
columns |
Configuration of source columns for each column in the current table. The keys in this dictionary are column names in the current table. The object stored in the dictionary contain a list of source columns. | ColumnLineageSourceSpecMap |
TableLineageTableListModel
Data lineage model that describes one source or target table of the current table.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
target_connection |
The connection name where the target table is defined. | string |
target_schema |
The schema name in the target connection where the target table is defined. | string |
target_table |
The name of the target table inside the target schema. | string |
source_connection |
The name of a source connection that is defined in DQOps and contains a source table from which the current table receives data. | string |
source_schema |
The name of a source schema within the source connection that contains a source table from which the current table receives data. | string |
source_table |
The name of a source schema within the source connection that contains a source table from which the current table receives data. | string |
data_lineage_source_tool |
The name of a source tool from which this data lineage information was copied. This field should be filled when the data lineage was imported from another data catalog or a data lineage tracking platform. | string |
properties |
A dictionary of mapping properties stored as a key/value dictionary. Data lineage synchronization tools that are importing data lineage mappings from external data lineage sources can use it to store mapping information. | Dict[string, string] |
can_edit |
Boolean flag that decides if the current user can update or delete this object. | boolean |
table_data_quality_status |
The current data quality status for the table, grouped by data quality dimensions. DQOps may return a null value when the results were not yet loaded into the cache. In that case, the client should wait a few seconds and retry a call to get the most recent data quality status of the table. | TableCurrentDataQualityStatusModel |