Last updated: July 22, 2025

DQOps REST API schemas operations

Operations for listing imported schemas from monitored data sources. Also provides operations for activating and deactivating multiple checks at once.

---

get_schema_monitoring_checks_model

Return a UI friendly model of configurations for data quality monitoring checks on a schema

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/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	Required
connection_name	Connection name	string
schema_name	Schema name	string
time_scale	Check time-scale	CheckTimeScale
table_name_pattern	Table name pattern	string
column_name_pattern	Column name pattern	string
column_data_type	Column data-type	string
check_target	Check target	CheckTarget
check_category	Check category	string
check_name	Check name	string
check_enabled	Check enabled	boolean
check_configured	Check configured	boolean
limit	Limit of results, the default value is 1000	long

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

[ {
  "sensor_parameters" : [ ],
  "disabled" : false,
  "configured" : false
}, {
  "sensor_parameters" : [ ],
  "disabled" : false,
  "configured" : false
}, {
  "sensor_parameters" : [ ],
  "disabled" : false,
  "configured" : false
} ]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_monitoring_checks_model
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_schema_monitoring_checks_model.sync(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_monitoring_checks_model
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_schema_monitoring_checks_model.asyncio(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_monitoring_checks_model
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_schema_monitoring_checks_model.sync(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_monitoring_checks_model
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_schema_monitoring_checks_model.asyncio(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

---

get_schema_monitoring_checks_templates

Return available data quality checks on a requested schema.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/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	Required
connection_name	Connection name	string
schema_name	Schema name	string
time_scale	Time scale	CheckTimeScale
check_target	Check target	CheckTarget
check_category	Check category	string
check_name	Check name	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

[ {
  "sensor_parameters_definitions" : [ ]
}, {
  "sensor_parameters_definitions" : [ ]
}, {
  "sensor_parameters_definitions" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_monitoring_checks_templates
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_schema_monitoring_checks_templates.sync(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_monitoring_checks_templates
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_schema_monitoring_checks_templates.asyncio(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_monitoring_checks_templates
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_schema_monitoring_checks_templates.sync(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_monitoring_checks_templates
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_schema_monitoring_checks_templates.asyncio(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

---

get_schema_partitioned_checks_model

Return a UI friendly model of configurations for data quality partitioned checks on a schema

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/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	Required
connection_name	Connection name	string
schema_name	Schema name	string
time_scale	Check time-scale	CheckTimeScale
table_name_pattern	Table name pattern	string
column_name_pattern	Column name pattern	string
column_data_type	Column data-type	string
check_target	Check target	CheckTarget
check_category	Check category	string
check_name	Check name	string
check_enabled	Check enabled	boolean
check_configured	Check configured	boolean
limit	Limit of results, the default value is 1000	long

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

[ {
  "sensor_parameters" : [ ],
  "disabled" : false,
  "configured" : false
}, {
  "sensor_parameters" : [ ],
  "disabled" : false,
  "configured" : false
}, {
  "sensor_parameters" : [ ],
  "disabled" : false,
  "configured" : false
} ]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_partitioned_checks_model
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_schema_partitioned_checks_model.sync(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_partitioned_checks_model
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_schema_partitioned_checks_model.asyncio(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_partitioned_checks_model
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_schema_partitioned_checks_model.sync(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_partitioned_checks_model
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_schema_partitioned_checks_model.asyncio(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

---

get_schema_partitioned_checks_templates

Return available data quality checks on a requested schema.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/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	Required
connection_name	Connection name	string
schema_name	Schema name	string
time_scale	Time scale	CheckTimeScale
check_target	Check target	CheckTarget
check_category	Check category	string
check_name	Check name	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

[ {
  "sensor_parameters_definitions" : [ ]
}, {
  "sensor_parameters_definitions" : [ ]
}, {
  "sensor_parameters_definitions" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_partitioned_checks_templates
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_schema_partitioned_checks_templates.sync(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_partitioned_checks_templates
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_schema_partitioned_checks_templates.asyncio(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_partitioned_checks_templates
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_schema_partitioned_checks_templates.sync(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_partitioned_checks_templates
from dqops.client.models import CheckTarget, \
                                CheckTimeScale

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_schema_partitioned_checks_templates.asyncio(
    'sample_connection',
    'sample_schema',
    CheckTimeScale.daily,
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

---

get_schema_profiling_checks_model

Return a flat list of configurations for profiling checks on a schema

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/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	Required
connection_name	Connection name	string
schema_name	Schema name	string
table_name_pattern	Table name pattern	string
column_name_pattern	Column name pattern	string
column_data_type	Column data-type	string
check_target	Check target	CheckTarget
check_category	Check category	string
check_name	Check name	string
check_enabled	Check enabled	boolean
check_configured	Check configured	boolean
limit	Limit of results, the default value is 1000	long

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

[ {
  "sensor_parameters" : [ ],
  "disabled" : false,
  "configured" : false
}, {
  "sensor_parameters" : [ ],
  "disabled" : false,
  "configured" : false
}, {
  "sensor_parameters" : [ ],
  "disabled" : false,
  "configured" : false
} ]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_profiling_checks_model
from dqops.client.models import CheckTarget

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_schema_profiling_checks_model.sync(
    'sample_connection',
    'sample_schema',
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_profiling_checks_model
from dqops.client.models import CheckTarget

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_schema_profiling_checks_model.asyncio(
    'sample_connection',
    'sample_schema',
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_profiling_checks_model
from dqops.client.models import CheckTarget

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_schema_profiling_checks_model.sync(
    'sample_connection',
    'sample_schema',
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_profiling_checks_model
from dqops.client.models import CheckTarget

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_schema_profiling_checks_model.asyncio(
    'sample_connection',
    'sample_schema',
    client=dqops_client
)

Expand to see the returned result

[
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    ),
    CheckConfigurationModel(
        sensor_parameters=[

        ],
        disabled=False,
        configured=False
    )
]

---

get_schema_profiling_checks_templates

Return available data quality checks on a requested schema.

Follow the link to see the source code on GitHub.

GET

http://localhost:8888/api/connections/{connectionName}/schemas/{schemaName}/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	Required
connection_name	Connection name	string
schema_name	Schema name	string
check_target	Check target	CheckTarget
check_category	Check category	string
check_name	Check name	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

[ {
  "sensor_parameters_definitions" : [ ]
}, {
  "sensor_parameters_definitions" : [ ]
}, {
  "sensor_parameters_definitions" : [ ]
} ]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_profiling_checks_templates
from dqops.client.models import CheckTarget

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_schema_profiling_checks_templates.sync(
    'sample_connection',
    'sample_schema',
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_profiling_checks_templates
from dqops.client.models import CheckTarget

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_schema_profiling_checks_templates.asyncio(
    'sample_connection',
    'sample_schema',
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_profiling_checks_templates
from dqops.client.models import CheckTarget

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_schema_profiling_checks_templates.sync(
    'sample_connection',
    'sample_schema',
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schema_profiling_checks_templates
from dqops.client.models import CheckTarget

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_schema_profiling_checks_templates.asyncio(
    'sample_connection',
    'sample_schema',
    client=dqops_client
)

Expand to see the returned result

[
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    ),
    CheckTemplate(
        sensor_parameters_definitions=[

        ]
    )
]

---

get_schemas

Returns a list of schemas inside a connection

Follow the link to see the source code on GitHub.

GET

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

Return value

Property name	Description	Data type
schema_model		List[SchemaModel]

Parameters of this method are described below

Property name	Description	Data type	Required
connection_name	Connection name	string

Usage examples

curlPython sync clientPython async clientPython auth sync clientPython auth async client

Execution

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

Expand to see the returned result

[ {
  "can_edit" : false,
  "can_collect_statistics" : false,
  "can_run_checks" : false,
  "can_delete_data" : false
}, {
  "can_edit" : false,
  "can_collect_statistics" : false,
  "can_run_checks" : false,
  "can_delete_data" : false
}, {
  "can_edit" : false,
  "can_collect_statistics" : false,
  "can_run_checks" : false,
  "can_delete_data" : false
} ]

Execution

from dqops import client
from dqops.client.api.schemas import get_schemas

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = get_schemas.sync(
    'sample_connection',
    client=dqops_client
)

Expand to see the returned result

[
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    ),
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    ),
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schemas

dqops_client = client.Client(
    'http://localhost:8888/',
    raise_on_unexpected_status=True
)

call_result = await get_schemas.asyncio(
    'sample_connection',
    client=dqops_client
)

Expand to see the returned result

[
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    ),
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    ),
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schemas

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = get_schemas.sync(
    'sample_connection',
    client=dqops_client
)

Expand to see the returned result

[
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    ),
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    ),
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    )
]

Execution

from dqops import client
from dqops.client.api.schemas import get_schemas

token = 's4mp13_4u7h_70k3n'

dqops_client = client.AuthenticatedClient(
    'http://localhost:8888/',
    token=token,
    raise_on_unexpected_status=True
)

call_result = await get_schemas.asyncio(
    'sample_connection',
    client=dqops_client
)

Expand to see the returned result

[
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    ),
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    ),
    SchemaModel(
        can_edit=False,
        can_collect_statistics=False,
        can_run_checks=False,
        can_delete_data=False
    )
]