Last updated: July 22, 2025
DQOps REST API data_sources models reference
The references of all objects used by data_sources REST API operations are listed below.
ConnectionTestStatus
Tabular output format for printing the tabular results.
The structure of this object is described below
| Data type | Enum values |
|---|---|
| string | SUCCESS FAILURE CONNECTION_ALREADY_EXISTS |
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).
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
connection_test_result |
Connection test result | ConnectionTestStatus |
error_message |
Optional error message when the status is not "SUCCESS" | string |
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.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
connection_name |
Connection name. | string |
schema_name |
Schema name. | string |
table_name |
Table name. | string |
already_imported |
A flag that tells if the table been already imported. | boolean |
SchemaRemoteModel
Schema model returned from REST API. Describes a schema on the source database with established connection.
The structure of this object is described below
| Property name | Description | Data type |
|---|---|---|
connection_name |
Connection name. | string |
schema_name |
Schema name. | string |
already_imported |
Has the schema been imported. | boolean |
import_table_job_parameters |
Job parameters for the import tables job that will import all tables from this schema. | ImportTablesQueueJobParameters |