data_management

2024.09

2024.03

2026.04

2025.09

2025.03

2026.01

2026.02

2026.03

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

Data Quality

Viya_35

The Data Quality API retrieves information about locales, functions, definitions, and tokens provided by a Quality Knowledge Base (QKB).<p><b>To provide your own session:</b> Endpoints under /dataQuality/environments/CAS/contexts/{{casServer}} support an optional sessionId parameter, which enables you to provide your own session to the Data Quality API. Providing a session can significantly improve performance. Management of the session is a client responsibility; the Data Quality API will not destroy the session after using it.

Returns header information and verifies that a definition exists in a given QKB and locale.

Specifies the name of the execution environment.

environmentName

contextName

Specifies the name of the QKB on the specified execution environment.

qkbName

Specifies the name of the locale that is supported by the specified QKB.

localeName

Specifies the name of the function that is supported by the specified QKB and locale.

functionName

Specifies the name of the definition that is supported by the specified function, QKB, and locale.

definitionName

sessionId

The request succeeded. The data quality definition exists in the specified context.

The requested definition does not exist for the specified qkb, locale and function.

Get headers and verify that a definition exists

A collection of QKBs across from all environments and contexts.

All QKBs Collection

The list of links to top-level resources and operations available from the root of the API.

baseCollection2

Context

Context Collection

Provides information about a data quality definition.

Definition

Provides a collection of data quality definitions.

Definition Collection

Provides information about an execution environment.

Environment

Environment Collection

error2

Provides information about the field content locale.

FieldContentLocale

A pageable collection of field content locale.

FieldContentLocale Collection

Function

Function Collection

link

Provides zero or more links to related resources and actions.

Name	Type	Required	Description
environmentName	string	true	Specifies the name of the execution environment.
contextName	string	true	Specifies the name of the execution environment.
qkbName	string	true	Specifies the name of the QKB on the specified execution environment.
localeName	string	true	Specifies the name of the locale that is supported by the specified QKB.
functionName	string	true	Specifies the name of the function that is supported by the specified QKB and locale.
definitionName	string	true	Specifies the name of the definition that is supported by the specified function, QKB, and locale.

Status	Meaning	Description
200	OK	The request succeeded. The data quality definition exists in the specified context.
404	Not Found	The requested definition does not exist for the specified qkb, locale and function.

Get headers and verify that a definition exists

Request Samples

Path Parameters

Query Parameters

Responses