columns

Manages columns inside a table

create_column

Creates a new column (adds a column metadata to the table)
Source code

POST

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

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	Column name	string

Request body

Description	Data type	Required
Column specification	ColumnSpec

Usage examples

curl

curl -X POST http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"type_snapshot\":{\"column_type\":\"string\",\"nullable\":false,\"length\":256},\"profiling_checks\":{\"nulls\":{\"profile_nulls_count\":{\"error\":{\"max_count\":10}}}}}"

delete_column

Deletes a column from the table
Source code

DELETE

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

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
column_name	Column name	string

Usage examples

curl

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

get_column

Returns the full column specification
Source code

GET

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

Return value

Property name	Description	Data type
column_model		ColumnModel

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	Column name	string

Usage examples

curl

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

get_column_basic

Returns the column specification
Source code

GET

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

Return value

Property name	Description	Data type
column_list_model		ColumnListModel

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	Column name	string

Usage examples

curl

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

get_column_comments

Return the list of comments assigned to a column
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Usage examples

curl

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

get_column_labels

Return the list of labels assigned to a column
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Usage examples

curl

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

get_column_monitoring_checks_basic_model

Return a simplistic UI friendly model of column level data quality monitoring on a column
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string
time_scale	Time scale	CheckTimeScale

Usage examples

curl

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

get_column_monitoring_checks_daily

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

GET

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

Return value

Property name	Description	Data type
column_daily_monitoring_check_categories_spec		ColumnDailyMonitoringCheckCategoriesSpec

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	Column name	string

Usage examples

curl

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

get_column_monitoring_checks_model

Return a UI friendly model of column level data quality monitoring on a column
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string
time_scale	Time scale	CheckTimeScale

Usage examples

curl

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

get_column_monitoring_checks_model_filter

Return a UI friendly model of column level data quality monitoring on a column filtered by category and check name
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column 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/columns/sample_column/monitoring/"daily"/model/filter/sample_category/sample_check^
    -H "Accept: application/json"

get_column_monitoring_checks_monthly

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

GET

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

Return value

Property name	Description	Data type
column_monthly_monitoring_check_categories_spec		ColumnMonthlyMonitoringCheckCategoriesSpec

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	Column name	string

Usage examples

curl

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

get_column_partitioned_checks_basic_model

Return a simplistic UI friendly model of column level data quality partitioned checks on a column
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string
time_scale	Time scale	CheckTimeScale

Usage examples

curl

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

get_column_partitioned_checks_daily

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

GET

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

Return value

Property name	Description	Data type
column_daily_partitioned_check_categories_spec		ColumnDailyPartitionedCheckCategoriesSpec

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	Column name	string

Usage examples

curl

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

get_column_partitioned_checks_model

Return a UI friendly model of column level data quality partitioned checks on a column
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string
time_scale	Time scale	CheckTimeScale

Usage examples

curl

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

get_column_partitioned_checks_model_filter

Return a UI friendly model of column level data quality partitioned checks on a column, filtered by category and check name
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column 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/columns/sample_column/partitioned/"daily"/model/filter/sample_category/sample_check^
    -H "Accept: application/json"

get_column_partitioned_checks_monthly

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

GET

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

Return value

Property name	Description	Data type
column_monthly_partitioned_check_categories_spec		ColumnMonthlyPartitionedCheckCategoriesSpec

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	Column name	string

Usage examples

curl

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

get_column_profiling_checks

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

GET

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

Return value

Property name	Description	Data type
column_profiling_check_categories_spec		ColumnProfilingCheckCategoriesSpec

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	Column name	string

Usage examples

curl

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

get_column_profiling_checks_basic_model

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

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Usage examples

curl

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

get_column_profiling_checks_model

Return a UI friendly model of data quality profiling checks on a column
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Usage examples

curl

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

get_column_profiling_checks_model_filter

Return a UI friendly model of data quality profiling checks on a column filtered by category and check name
Source code

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column 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/columns/sample_column/profiling/model/filter/sample_category/sample_check^
    -H "Accept: application/json"

get_column_statistics

Returns the column specification with the metrics captured by the most recent statistics collection.
Source code

GET

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

Return value

Property name	Description	Data type
column_statistics_model		ColumnStatisticsModel

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	Column name	string

Usage examples

curl

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

get_columns

Returns a list of columns inside a table
Source code

GET

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

Return value

Property name	Description	Data type
column_list_model		List[ColumnListModel]

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/columns^
    -H "Accept: application/json"

get_columns_statistics

Returns a list of columns inside a table with the metrics captured by the most recent statistics collection.
Source code

GET

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

Return value

Property name	Description	Data type
table_columns_statistics_model		TableColumnsStatisticsModel

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/columns/statistics^
    -H "Accept: application/json"

update_column

Updates an existing column specification, changing all the fields (even the column level data quality checks).
Source code

PUT

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

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	Column name	string

Request body

Description	Data type	Required
Column specification	ColumnSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"type_snapshot\":{\"column_type\":\"string\",\"nullable\":false,\"length\":256},\"profiling_checks\":{\"nulls\":{\"profile_nulls_count\":{\"error\":{\"max_count\":10}}}}}"

update_column_basic

Updates an existing column, changing only the basic information like the expected data type (the data type snapshot).
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Request body

Description	Data type	Required
Basic column information to store	ColumnListModel

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/basic^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"connection_name\":\"sample_connection\",\"table\":{\"schema_name\":\"sample_schema\",\"table_name\":\"sample_table\"},\"column_name\":\"sample_column\",\"has_any_configured_checks\":true,\"has_any_configured_profiling_checks\":true,\"type_snapshot\":{\"column_type\":\"string\",\"nullable\":false,\"length\":256},\"can_edit\":false,\"can_collect_statistics\":true,\"can_run_checks\":true,\"can_delete_data\":true}"

update_column_comments

Updates the list of comments assigned to a column.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Request body

Description	Data type	Required
List of comments to stored (replaced) on the column or an empty object to clear the list of assigned comments on the column	List[CommentSpec]

Usage examples

curl

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

update_column_labels

Updates the list of labels assigned to a column.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Request body

Description	Data type	Required
List of labels to stored (replaced) on the column or an empty object to clear the list of assigned labels on the column	List[string]

Usage examples

curl

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

update_column_monitoring_checks_daily

Updates configuration of daily column level data quality monitoring on a column.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Request body

Description	Data type	Required
Configuration of daily column level data quality monitoring to configure on a column or an empty object to clear the list of assigned daily data quality monitoring on the column	ColumnDailyMonitoringCheckCategoriesSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/monitoring/daily^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"nulls\":{\"daily_nulls_count\":{\"error\":{\"max_count\":10}}}}"

update_column_monitoring_checks_model

Updates configuration of column level data quality monitoring on a column, for a given time scale, from a UI friendly model.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column 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/columns/sample_column/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_column_monitoring_checks_monthly

Updates configuration of monthly column level data quality monitoring checks on a column.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Request body

Description	Data type	Required
Configuration of monthly column level data quality monitoring to configure on a column or an empty object to clear the list of assigned monthly data quality monitoring on the column	ColumnMonthlyMonitoringCheckCategoriesSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/monitoring/monthly^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"nulls\":{\"monthly_nulls_count\":{\"error\":{\"max_count\":10}}}}"

update_column_partitioned_checks_daily

Updates configuration of daily column level data quality partitioned checks on a column.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Request body

Description	Data type	Required
Configuration of daily column level data quality partitioned checks to configure on a column or an empty object to clear the list of assigned data quality partitioned checks on the column	ColumnDailyPartitionedCheckCategoriesSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/partitioned/daily^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"nulls\":{\"daily_partition_nulls_count\":{\"error\":{\"max_count\":10}}}}"

update_column_partitioned_checks_model

Updates configuration of column level data quality partitioned checks on a column, for a given time scale, from a UI friendly model.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column 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/columns/sample_column/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_column_partitioned_checks_monthly

Updates configuration of monthly column level data quality partitioned checks on a column.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Request body

Description	Data type	Required
Configuration of monthly column level data quality partitioned checks to configure on a column or an empty object to clear the list of assigned data quality partitioned checks on the column	ColumnMonthlyPartitionedCheckCategoriesSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/partitioned/monthly^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"nulls\":{\"monthly_partition_nulls_count\":{\"error\":{\"max_count\":10}}}}"

update_column_profiling_checks

Updates configuration of column level data quality profiling checks on a column.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column name	string

Request body

Description	Data type	Required
Configuration of column level data quality profiling checks to configure on a column or an empty object to clear the list of assigned data quality profiling checks on the column	ColumnProfilingCheckCategoriesSpec

Usage examples

curl

curl -X PUT http://localhost:8888/api/connections/sample_connection/schemas/sample_schema/tables/sample_table/columns/sample_column/profiling^
    -H "Accept: application/json"^
    -H "Content-Type: application/json"^
    -d^
    "{\"nulls\":{\"profile_nulls_count\":{\"error\":{\"max_count\":10}}}}"

update_column_profiling_checks_model

Updates configuration of column level data quality profiling checks on a column from a UI friendly model.
Source code

PUT

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/tables/{tableName}/columns/{columnName}/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
column_name	Column 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/columns/sample_column/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}"