Last updated: July 22, 2025
DQOps REST API connections models reference
The references of all objects used by connections REST API operations are listed below.
AllChecksPatchParameters
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
check_search_filters |
Filters addressing basic tree search parameters. These filters takes precedence over other selectors. | CheckSearchFilters |
check_model_patch |
Sample configured check model which will pasted onto selected checks. | CheckModel |
selected_tables_to_columns |
List of concrete table and column names which will be the target. Column mappings are ignored for table level checks. This filter is applied at the end. | Dict[string, List[string]] |
override_conflicts |
Override existing configurations if they're present. If false, apply updates only to the fields for which no configuration exists. | boolean |
BulkCheckDeactivateParameters
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
check_search_filters |
Filters addressing basic tree search parameters. These filters takes precedence over other selectors. | CheckSearchFilters |
selected_tables_to_columns |
List of concrete table and column names which will be the target. Column mappings are ignored for table level checks. This filter is applied at the end. | Dict[string, List[string]] |
ConnectionSpecificationModel
Connection model returned by the rest api.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
connection_name |
Connection name. | string |
connection_hash |
Connection hash that identifies the connection using a unique hash code. | long |
spec |
Full connection specification, including all nested objects (but not a list of tables). | ConnectionSpec |
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 |