tables

Manages tables inside a connection/schema

create_table

Creates a new table (adds a table metadata)
Source code

POST

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Table specification	TableSpec

Usage examples

curl

curl -X POST http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"timestamp_columns\":{\"event_timestamp_column\":\"col1\",\"ingestion_timestamp_column\":\"col2\",\"partition_by_column\":\"col3\"},\"incremental_time_window\":{\"daily_partitioning_recent_days\":7,\"monthly_partitioning_recent_months\":1},\"profiling_checks\":{\"volume\":{\"profile_row_count\":{\"error\":{\"min_count\":1}}}},\"columns\":{}}"

delete_table

Deletes a table
Source code

DELETE

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}

Return value

Property name	Description	Data type
dqo_queue_job_id		DqoQueueJobId

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl -X DELETE http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table^
    -H "Accept: application/json"

get_table

Return the table specification
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}

Return value

Property name	Description	Data type
table_model		TableModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table^
    -H "Accept: application/json"

get_table_basic

Return the basic table information
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/basic

Return value

Property name	Description	Data type
table_list_model		TableListModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/basic^
    -H "Accept: application/json"

get_table_columns_monitoring_checks_model

Return a UI friendly model of configurations for column-level data quality monitoring checks on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columnchecks/monitoring/{timeScale}/model

Return value

Property name	Description	Data type
check_configuration_model		List[CheckConfigurationModel]

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Check time-scale	CheckTimeScale
column_name_pattern	Column name pattern	string
column_data_type	Column data-type	string
check_category	Check category	string
check_name	Check name	string
check_enabled	Check enabled	boolean
check_configured	Check configured	boolean

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columnchecks/monitoring/"daily"/model^
    -H "Accept: application/json"

get_table_columns_partitioned_checks_model

Return a UI friendly model of configurations for column-level data quality partitioned checks on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columnchecks/partitioned/{timeScale}/model

Return value

Property name	Description	Data type
check_configuration_model		List[CheckConfigurationModel]

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Check time-scale	CheckTimeScale
column_name_pattern	Column name pattern	string
column_data_type	Column data-type	string
check_category	Check category	string
check_name	Check name	string
check_enabled	Check enabled	boolean
check_configured	Check configured	boolean

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columnchecks/partitioned/"daily"/model^
    -H "Accept: application/json"

get_table_columns_profiling_checks_model

Return a UI friendly model of configurations for column-level data quality profiling checks on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columnchecks/profiling/model

Return value

Property name	Description	Data type
check_configuration_model		List[CheckConfigurationModel]

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
column_name_pattern	Column name pattern	string
column_data_type	Column data-type	string
check_category	Check category	string
check_name	Check name	string
check_enabled	Check enabled	boolean
check_configured	Check configured	boolean

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columnchecks/profiling/model^
    -H "Accept: application/json"

get_table_comments

Return the list of comments added to a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/comments

Return value

Property name	Description	Data type
comment_spec		List[CommentSpec]

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/comments^
    -H "Accept: application/json"

get_table_daily_monitoring_checks

Return the configuration of daily table level data quality monitoring on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/monitoring/daily

Return value

Property name	Description	Data type
table_daily_monitoring_check_categories_spec		TableDailyMonitoringCheckCategoriesSpec

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/daily^
    -H "Accept: application/json"

get_table_daily_partitioned_checks

Return the configuration of daily table level data quality partitioned checks on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioned/daily

Return value

Property name	Description	Data type
table_daily_partitioned_check_categories_spec		TableDailyPartitionedCheckCategoriesSpec

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/daily^
    -H "Accept: application/json"

get_table_default_grouping_configuration

Return the default data grouping configuration for a table.
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/defaultgroupingconfiguration

Return value

Property name	Description	Data type
data_grouping_configuration_spec		DataGroupingConfigurationSpec

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/defaultgroupingconfiguration^
    -H "Accept: application/json"

get_table_incident_grouping

Return the configuration of incident grouping on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/incidentgrouping

Return value

Property name	Description	Data type
table_incident_grouping_spec		TableIncidentGroupingSpec

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/incidentgrouping^
    -H "Accept: application/json"

get_table_labels

Return the list of labels assigned to a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/labels

Return value

Property name	Description	Data type
string		List[string]

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/labels^
    -H "Accept: application/json"

get_table_monitoring_checks_basic_model

Return a simplistic UI friendly model of table level data quality monitoring on a table for a given time scale
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/monitoring/{timeScale}/model/basic

Return value

Property name	Description	Data type
check_container_list_model		CheckContainerListModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Time scale	CheckTimeScale

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/"daily"/model/basic^
    -H "Accept: application/json"

get_table_monitoring_checks_model

Return a UI friendly model of configurations for table level data quality monitoring on a table for a given time scale
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/monitoring/{timeScale}/model

Return value

Property name	Description	Data type
check_container_model		CheckContainerModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Time scale	CheckTimeScale

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/"daily"/model^
    -H "Accept: application/json"

get_table_monitoring_checks_model_filter

Return a UI friendly model of configurations for table level data quality monitoring on a table for a given time scale, filtered by category and check name.
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/monitoring/{timeScale}/model/filter/{checkCategory}/{checkName}

Return value

Property name	Description	Data type
check_container_model		CheckContainerModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Time scale	CheckTimeScale
check_category	Check category	string
check_name	Check name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/"daily"/model/filter/sample_category/sample_check^
    -H "Accept: application/json"

get_table_monitoring_checks_monthly

Return the configuration of monthly table level data quality monitoring on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/monitoring/monthly

Return value

Property name	Description	Data type
table_monthly_monitoring_check_categories_spec		TableMonthlyMonitoringCheckCategoriesSpec

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/monthly^
    -H "Accept: application/json"

get_table_monitoring_checks_templates

Return available data quality checks on a requested table.
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/bulkenable/monitoring/{timeScale}

Return value

Property name	Description	Data type
check_template		List[CheckTemplate]

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Time scale	CheckTimeScale
check_category	Check category	string
check_name	Check name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/bulkenable/monitoring/"daily"^
    -H "Accept: application/json"

get_table_partitioned_checks_basic_model

Return a simplistic UI friendly model of table level data quality partitioned checks on a table for a given time scale
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioned/{timeScale}/model/basic

Return value

Property name	Description	Data type
check_container_list_model		CheckContainerListModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Time scale	CheckTimeScale

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/"daily"/model/basic^
    -H "Accept: application/json"

get_table_partitioned_checks_model

Return a UI friendly model of configurations for table level data quality partitioned checks on a table for a given time scale
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioned/{timeScale}/model

Return value

Property name	Description	Data type
check_container_model		CheckContainerModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Time scale	CheckTimeScale

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/"daily"/model^
    -H "Accept: application/json"

get_table_partitioned_checks_model_filter

Return a UI friendly model of configurations for table level data quality partitioned checks on a table for a given time scale, filtered by category and check name.
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioned/{timeScale}/model/filter/{checkCategory}/{checkName}

Return value

Property name	Description	Data type
check_container_model		CheckContainerModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Time scale	CheckTimeScale
check_category	Check category	string
check_name	Check name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/"daily"/model/filter/sample_category/sample_check^
    -H "Accept: application/json"

get_table_partitioned_checks_monthly

Return the configuration of monthly table level data quality partitioned checks on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioned/monthly

Return value

Property name	Description	Data type
table_monthly_partitioned_check_categories_spec		TableMonthlyPartitionedCheckCategoriesSpec

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/monthly^
    -H "Accept: application/json"

get_table_partitioned_checks_templates

Return available data quality checks on a requested table.
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/bulkenable/partitioned/{timeScale}

Return value

Property name	Description	Data type
check_template		List[CheckTemplate]

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Time scale	CheckTimeScale
check_category	Check category	string
check_name	Check name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/bulkenable/partitioned/"daily"^
    -H "Accept: application/json"

get_table_partitioning

Return the table partitioning information
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioning

Return value

Property name	Description	Data type
table_partitioning_model		TablePartitioningModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioning^
    -H "Accept: application/json"

get_table_profiling_checks

Return the configuration of table level data quality checks on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/profiling

Return value

Property name	Description	Data type
table_profiling_check_categories_spec		TableProfilingCheckCategoriesSpec

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/profiling^
    -H "Accept: application/json"

get_table_profiling_checks_basic_model

Return a simplistic UI friendly model of all table level data quality profiling checks on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/profiling/model/basic

Return value

Property name	Description	Data type
check_container_list_model		CheckContainerListModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/profiling/model/basic^
    -H "Accept: application/json"

get_table_profiling_checks_model

Return a UI friendly model of configurations for all table level data quality profiling checks on a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/profiling/model

Return value

Property name	Description	Data type
check_container_model		CheckContainerModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/profiling/model^
    -H "Accept: application/json"

get_table_profiling_checks_model_filter

Return a UI friendly model of configurations for all table level data quality profiling checks on a table passing a filter
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/profiling/model/filter/{checkCategory}/{checkName}

Return value

Property name	Description	Data type
check_container_model		CheckContainerModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
check_category	Check category	string
check_name	Check name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/profiling/model/filter/sample_category/sample_check^
    -H "Accept: application/json"

get_table_profiling_checks_templates

Return available data quality checks on a requested table.
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/bulkenable/profiling

Return value

Property name	Description	Data type
check_template		List[CheckTemplate]

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
check_category	Check category	string
check_name	Check name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/bulkenable/profiling^
    -H "Accept: application/json"

get_table_scheduling_group_override

Return the schedule override configuration for a table
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/schedulesoverride/{schedulingGroup}

Return value

Property name	Description	Data type
monitoring_schedule_spec		MonitoringScheduleSpec

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
scheduling_group	Check scheduling group (named schedule)	CheckRunScheduleGroup

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/schedulesoverride/"partitioned_daily"^
    -H "Accept: application/json"

get_table_statistics

Returns a list of the profiler (statistics) metrics on a chosen table captured during the most recent statistics collection.
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/statistics

Return value

Property name	Description	Data type
table_statistics_model		TableStatisticsModel

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/statistics^
    -H "Accept: application/json"

get_tables

Returns a list of tables inside a connection/schema
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables

Return value

Property name	Description	Data type
table_list_model		List[TableListModel]

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string
schema_name	Schema name	string

Usage examples

curl

curl http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables^
    -H "Accept: application/json"

update_table

Updates an existing table specification, changing all the fields
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Full table specification	TableSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"timestamp_columns\":{\"event_timestamp_column\":\"col1\",\"ingestion_timestamp_column\":\"col2\",\"partition_by_column\":\"col3\"},\"incremental_time_window\":{\"daily_partitioning_recent_days\":7,\"monthly_partitioning_recent_months\":1},\"profiling_checks\":{\"volume\":{\"profile_row_count\":{\"error\":{\"min_count\":1}}}},\"columns\":{}}"

update_table_basic

Updates the basic field of an existing table, changing only the most important fields.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/basic

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Table basic model with the updated settings	TableListModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/basic^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"connection_name\":\"sample_connection\",\"table_hash\":2314522140819107818,\"target\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"has_any_configured_checks\":true,\"has_any_configured_profiling_checks\":true,\"run_checks_job_template\":{\"connection\":\"sample_connection\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true},\"run_profiling_checks_job_template\":{\"connection\":\"sample_connection\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"profiling\"},\"run_monitoring_checks_job_template\":{\"connection\":\"sample_connection\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"monitoring\"},\"run_partition_checks_job_template\":{\"connection\":\"sample_connection\",\"fullTableName\":\"sample_schema.sample_table\",\"enabled\":true,\"checkType\":\"partitioned\"},\"data_clean_job_template\":{\"fullTableName\":\"sample_schema.sample_table\",\"deleteErrors\":true,\"deleteStatistics\":true,\"deleteCheckResults\":true,\"deleteSensorReadouts\":true},\"can_edit\":true,\"can_collect_statistics\":true,\"can_run_checks\":true,\"can_delete_data\":true}"

update_table_comments

Updates the list of comments on an existing table.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/comments

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
List of comments to attach (replace) on a table or an empty object to clear the list of comments on a table	List[CommentSpec]

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/comments^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "[]"

update_table_daily_monitoring_checks

Updates the list of daily table level data quality monitoring on an existing table.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/monitoring/daily

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Configuration of daily table level data quality monitoring to store or an empty object to remove all data quality monitoring on the table level (column level monitoring are preserved).	TableDailyMonitoringCheckCategoriesSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/daily^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"volume\":{\"daily_row_count\":{\"error\":{\"min_count\":1}}}}"

update_table_default_grouping_configuration

Updates the default data grouping configuration at a table level.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/defaultgroupingconfiguration

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Default data grouping configuration to store or an empty object to clear the data grouping configuration on a table level	DataGroupingConfigurationSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/defaultgroupingconfiguration^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"level_3\":{\"source\":\"column_value\",\"column\":\"sample_column\"}}"

update_table_incident_grouping

Updates the configuration of incident grouping on a table.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/incidentgrouping

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
New configuration of the table's incident grouping	TableIncidentGroupingSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/incidentgrouping^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"grouping_level\":\"table_dimension\",\"minimum_severity\":\"warning\",\"divide_by_data_group\":true,\"disabled\":false}"

update_table_labels

Updates the list of assigned labels of an existing table.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/labels

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
List of labels to attach (replace) on a table or an empty object to clear the list of labels on a table	List[string]

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/labels^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "[]"

update_table_monitoring_checks_model

Updates the data quality monitoring from a model that contains a patch with changes.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/monitoring/{timeScale}/model

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Time scale	CheckTimeScale

Request body

Description	Data type	Required
Model with the changes to be applied to the data quality monitoring configuration.	CheckContainerModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/"daily"/model^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"categories\":[{\"category\":\"sample_category\",\"help_text\":\"Sample help text\",\"checks\":[{\"check_name\":\"sample_check\",\"help_text\":\"Sample help text\",\"sensor_parameters\":[],\"sensor_name\":\"sample_target/sample_category/sample_sensor\",\"quality_dimension\":\"sample_quality_dimension\",\"supports_grouping\":false,\"disabled\":false,\"exclude_from_kpi\":false,\"include_in_sla\":false,\"configured\":false,\"can_edit\":false,\"can_run_checks\":false,\"can_delete_data\":false}]}],\"can_edit\":false,\"can_run_checks\":false,\"can_delete_data\":false}"

update_table_monitoring_checks_monthly

Updates the list of monthly table level data quality monitoring on an existing table.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/monitoring/monthly

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Configuration of monthly table level data quality monitoring to store or an empty object to remove all data quality monitoring on the table level (column level monitoring are preserved).	TableMonthlyMonitoringCheckCategoriesSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/monitoring/monthly^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"volume\":{\"monthly_row_count\":{\"error\":{\"min_count\":1}}}}"

update_table_partitioned_checks_daily

Updates the list of daily table level data quality partitioned checks on an existing table.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioned/daily

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Configuration of daily table level data quality partitioned checks to store or an empty object to remove all data quality partitioned checks on the table level (column level partitioned checks are preserved).	TableDailyPartitionedCheckCategoriesSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/daily^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"volume\":{\"daily_partition_row_count\":{\"error\":{\"min_count\":1}}}}"

update_table_partitioned_checks_model

Updates the data quality partitioned checks from a model that contains a patch with changes.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioned/{timeScale}/model

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
time_scale	Time scale	CheckTimeScale

Request body

Description	Data type	Required
Model with the changes to be applied to the data quality partitioned checks configuration.	CheckContainerModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/"daily"/model^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"categories\":[{\"category\":\"sample_category\",\"help_text\":\"Sample help text\",\"checks\":[{\"check_name\":\"sample_check\",\"help_text\":\"Sample help text\",\"sensor_parameters\":[],\"sensor_name\":\"sample_target/sample_category/sample_sensor\",\"quality_dimension\":\"sample_quality_dimension\",\"supports_grouping\":false,\"disabled\":false,\"exclude_from_kpi\":false,\"include_in_sla\":false,\"configured\":false,\"can_edit\":false,\"can_run_checks\":false,\"can_delete_data\":false}]}],\"can_edit\":false,\"can_run_checks\":false,\"can_delete_data\":false}"

update_table_partitioned_checks_monthly

Updates the list of monthly table level data quality partitioned checks on an existing table.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioned/monthly

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Configuration of monthly table level data quality partitioned checks to store or an empty object to remove all data quality partitioned checks on the table level (column level partitioned checks are preserved).	TableMonthlyPartitionedCheckCategoriesSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioned/monthly^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"volume\":{\"monthly_partition_row_count\":{\"error\":{\"min_count\":1}}}}"

update_table_partitioning

Updates the table partitioning configuration of an existing table.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/partitioning

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Table partitioning model with the updated settings	TablePartitioningModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/partitioning^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"connection_name\":\"sample_connection\",\"target\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"timestamp_columns\":{\"event_timestamp_column\":\"col1\",\"ingestion_timestamp_column\":\"col2\",\"partition_by_column\":\"col3\"},\"incremental_time_window\":{\"daily_partitioning_recent_days\":7,\"monthly_partitioning_recent_months\":1},\"can_edit\":true}"

update_table_profiling_checks

Updates the list of table level data quality profiling checks on an existing table.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/profiling

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Configuration of table level data quality profiling checks to store or an empty object to remove all data quality profiling checks on the table level (column level profiling checks are preserved).	TableProfilingCheckCategoriesSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/profiling^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"volume\":{\"profile_row_count\":{\"error\":{\"min_count\":1}}}}"

update_table_profiling_checks_model

Updates the data quality profiling checks from a model that contains a patch with changes.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/profiling/model

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string

Request body

Description	Data type	Required
Model with the changes to be applied to the data quality profiling checks configuration.	CheckContainerModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/profiling/model^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"categories\":[{\"category\":\"sample_category\",\"help_text\":\"Sample help text\",\"checks\":[{\"check_name\":\"sample_check\",\"help_text\":\"Sample help text\",\"sensor_parameters\":[],\"sensor_name\":\"sample_target/sample_category/sample_sensor\",\"quality_dimension\":\"sample_quality_dimension\",\"supports_grouping\":false,\"disabled\":false,\"exclude_from_kpi\":false,\"include_in_sla\":false,\"configured\":false,\"can_edit\":false,\"can_run_checks\":false,\"can_delete_data\":false}]}],\"can_edit\":false,\"can_run_checks\":false,\"can_delete_data\":false}"

update_table_scheduling_group_override

Updates the overridden schedule configuration of an existing table for a named schedule group (named schedule for checks using the same time scale).
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/schedulesoverride/{schedulingGroup}

Parameters of this method are described below

Property name	Description	Data type
connection_name	Connection name	string
schema_name	Schema name	string
table_name	Table name	string
scheduling_group	Check scheduling group (named schedule)	CheckRunScheduleGroup

Request body

Description	Data type	Required
Table's overridden schedule configuration to store or an empty object to clear the schedule configuration on a table	MonitoringScheduleSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/schedulesoverride/"partitioned_daily"^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"cron_expression\":\"0 12 1 * *\"}"