Records

Validate Record WSDL

Validates a custom record. If the custom knowledge graph also contains a mappping, the mapping is applied ad-hoc and CDL validation rules are applied as well

SecurityapiKey
Request
Request Body schema: application/json
activatedRules
Array of strings (BusinessRuleUrl)

Urls of cdl rules that are active during validation process.

Array of objects (Criticality)
customKnowledgeGraph
string

Identifier for the custom knowledge graph that should be used for validation

dataMapperDefinitionId
string (DataMapperDefinitionId)

Mapping ID that should be used for the mapping. Overrules a mapping of the knowledge graph (if exists). To run validation against CDL Rules data mapping definition by given ID must exist and user executing validation needs to have permission to access it.

dataMirrorStorageId
string

Storage used for data mirror enrichment

Array of objects (DataSource)

Rules with data sources passed here are not used in validation process

Array of objects (DataSource)

If data sources are disabled by feature toogle you can enable some of them passing their prefixes here

externalId
string

unique id from the client system

featuresOff
Array of strings

Deactivate features

Items Enum: "ENRICH_DATA_MIRROR_CHANGES" "SHOW_BUSINESSPARTNER" "USE_AUTOMATION_RULES"
featuresOn
Array of strings

Activate features

Items Enum: "ENRICH_DATA_MIRROR_CHANGES" "EXTERNAL_SOURCES_OFF" "SHOW_BUSINESSPARTNER" "SHOW_DEBUG_INFO" "USE_AUTOMATION_RULES"
ignoredRules
Array of strings (BusinessRuleUrl)

Urls of cdl rules ignored during validation process.

object
profile
string (ValidationProfile)

Profile which is used during validation. Default value is STANDARD

Enum: Description
QUICK

This profile checks data quality of records in a quick way, i.e. data quality rules that have a negative impact on performance.

STANDARD

This profile checks data quality using CDQ's standard configuration.

QUALIFICATION

Deprecated.

AUTOMATION

Deprecated.

EU_VAT_QUALIFICATION

This profile qualifies EU VATs using CDQ's default configuration of data quality rules for qualified checks of EU VATs

DATA_SHARING_QUALITY_GATE

Quality checks ensure that only valid data enters the CDQ Community Data Pool

IDENTIFIER_QUALITY

This profile checks identifiers with a standard configuration of data quality rules. It does not comprise qualified checks of identifiers regarding e.g. name or address.

ADDRESS_QUALITY

This profile checks addresses with a standard configuration of data quality rules.

WORLDWIDE_IDENTIFIER_QUALIFICATION

This profile qualifies any supported business identifier (e.g. tax numbers) worldwide using CDQ's default configuration of data quality rules for qualified checks of a particular identifier

FEATURES_OFF

This profile turns off any qualification rules and is designed for custom rules selection.

record
string

Stringified JSON of the custom record

Array of objects (RuleCategoryOn)

Categories use for selecting active business rules

ruleStatuses
Array of strings (RuleStatus)

Filter for rule status.

Items Enum: Description
RELEASED

Rule was moved from status PLANNED automatically during daily testing or by manual maintenance.

DRAFT

Rule was created as a draft and it will be not executed.

HYPERCARE

Rule was moved from status DEACTIVATED automatically during daily testing.

Responses
200

OK

post/v2/records/validate
Request samples
application/json
{}
Response samples
{
  • "dataDefects": [],
  • "decisions": [],
  • "qualificationResult": {
    },
  • "summary": {
    },
  • "debugInfo": {},
  • "diff": "{\"Identified_changes\":[{\"op\":\"add\",\"path\":\"/partner/header/objectTask\",\"value\":\"C\"}]}",
  • "businessPartner": {
    }
}