Data Quality

Loading...
The Data Quality API retrieves information about locales, functions, definitions, and tokens provided by a Quality Knowledge Base (QKB).

QKB

Contains the operations for the QKB resource.
get
Get a list of all QKBs on all contexts
Internal-Use OnlyReturns a list of all available QKBs on all execution contexts that are available to the user.
/qkbs
get
Get a list of all available QKBs
Internal-Use OnlyReturns a list of all QKBs in a specified execution environment that are available to the user.
/environments/{environmentName}/contexts/{contextName}/qkbs
get
Get QKB information
Internal-Use OnlyReturns information for a QKB in a specified execution environment.
/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}
head
Get headers and verify that QKB exists
Internal-Use OnlyReturns header information and verifies that a QKB exists in a specified execution environment.
/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}

FieldContentLocale

Contains the operations for field content locale list.
get
Get list of locales for field content analysis
Internal-Use OnlyReturns a list of all available locale with corresponding language and country that support field content analysis.
/fieldContentLocale
post
Create new field content locale
Internal-Use OnlyCreate a new field content locale with provided information.
/fieldContentLocale
get
Get details about a field content locale
Internal-Use OnlyReturns information about a specified field content locale.
/fieldContentLocale/{locale}
head
Get details about a field content locale
Internal-Use OnlyReturns information about a specified field content locale.
/fieldContentLocale/{locale}
put
Update field content locale by locale
Internal-Use OnlyUpdate field content locale by locale. Only a user defined field content locale can be updated. The out of the box field content locale cannot be updated by the user.
/fieldContentLocale/{locale}
delete
Delete a field content locale
Internal-Use OnlyDeletes a field content locale. Only user defined field content locale can be deleted. The out of the box field content locale cannot be deleted by the user.
/fieldContentLocale/{locale}

Function

Contains the operations for QKB functions.
get
Get supported functions for a locale
Internal-Use OnlyReturns a list of functions that are supported by a specified locale, QKB, and execution environment.
/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions
get
Get function information
Internal-Use OnlyReturns function information for a specified locale, QKB, and execution environment.
/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}
head
Get headers and verify that a function is available for locale
Internal-Use OnlyReturns header information and verifies that a function is available for a given locale, QKB, and context.
/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}

Definitions

Contains the operations for QKB definitions.
get
Get a list of data quality definitions
Internal-Use OnlyReturns a list of data quality definitions that are supported by a specified locale and QKB.
/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions
get
Get definition information
Internal-Use OnlyReturns definition information for a given QKB, locale, and function.
/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}
head
Get headers and verify that a definition exists
Internal-Use OnlyReturns header information and verifies that a definition exists in a given QKB and locale.
/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}

Tokens

Contains the operations for QKB tokens.
get
Get a token list from a QKB
Internal-Use OnlyReturns a list of tokens for a specified data quality function, definition. QKB, and locale.
/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens
get
Get information about a token
Internal-Use OnlyReturns information about a token from a specified QKB, locale, function, and definition.
/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}
head
Get headers and verify that a token exists in a given definition
Internal-Use OnlyReturns header information and verifies that a token exists in a specified data quality definition.
/environments/{environmentName}/contexts/{contextName}/qkbs/{qkbName}/locales/{localeName}/functions/{functionName}/definitions/{definitionName}/tokens/{tokenName}