REST API Integration

The DQ Validator module integrates with IBM Cloud Pak for Data through REST API providers.

Note

This section provides an overview. Detailed API documentation is available in the API Reference.

Available Providers

• GlossaryProvider - Fetch glossary terms and DQ constraints

• CamsProvider - Fetch data assets from CAMS

• AssetsProvider - Manage data assets

• DimensionsProvider - Manage DQ dimensions

• ChecksProvider - Manage DQ checks

• IssuesProvider - Track and manage DQ issues

• DQSearchProvider - Search for DQ checks and assets

Example Usage

from wxdi.common.auth import AuthConfig, AuthProvider, EnvironmentType
from wxdi.dq_validator.provider import ProviderConfig, GlossaryProvider

# Set up authentication
auth_config = AuthConfig(
    environment_type=EnvironmentType.IBM_CLOUD,
    api_key="your-api-key"
)
auth_provider = AuthProvider(auth_config)
token = auth_provider.get_token()

# Use provider
provider_config = ProviderConfig(
    base_url="https://api.dataplatform.cloud.ibm.com",
    auth_token=token
)
glossary_provider = GlossaryProvider(provider_config)

For detailed usage examples and API documentation, see the API Reference.