Configuration

Everything about Configuration

Create new configuration

Creates a new configuration for the current user. The configuration is stored in the users workspace and can be used for validation of business partners and identifiers.

SecurityapiKey

Request

Request Body schema: application/json

	object (BusinessPartnerValidationConfiguration) Configuration of the validation process for a single Business Partner record.
name	string The name of the configuration. Example: "Custom configuration name"
workspaceId	string (WorkspaceId) Uniquely identifying ID of the workspace. Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"

Responses

200

Configuration created successfully

400

Bad Request.

post/configurations/businesspartnervalidation

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"name": "demo config",
"configuration": {"ignoredRules": ["https://meta.cdq.com/Care_of_information_misplaced_(business_partner_name)",
"https://meta.cdq.com/Checkdigit_of_state_tax_number_(Brasil_-_Acre_(AC))"
],
"activatedRules": ["https://meta.cdq.com/Business_partner_name_missing_(Name_LOCAL)"
],
"featuresOff": ["ENRICH_LEGAL_FORM",
"SHOW_DECISIONS"
],
"featuresOn": ["SHOW_LOOKUP_RESULTS",
"SHOW_BUSINESSPARTNER",
"SHOW_DATA_DEFECTS"
],
"ruleCategoriesOn": [{"url": "https://meta.cdq.ch/Missing_legal_form"
}
],
"criticalities": [{"businessRuleUrl": "https://meta.cdq.com/Dummy_post_code_detected_(AF)",
"violationLevel": "WARNING"
},
{"businessRuleUrl": "https://meta.cdq.com/Unallowed_pattern_in_name_detected_(AF)",
"violationLevel": "INFO"
}
],
"ruleStatuses": ["RELEASED"
],
"dataSourcesOn": [{"aleiPrefix": "VIES"
}
],
"validationProfile": "EU_VAT_QUALIFICATION"
}
}

Response samples

application/json

{"name": "demo config",
"configuration": {"ignoredRules": ["https://meta.cdq.com/Care_of_information_misplaced_(business_partner_name)",
"https://meta.cdq.com/Checkdigit_of_state_tax_number_(Brasil_-_Acre_(AC))"
],
"activatedRules": ["https://meta.cdq.com/Business_partner_name_missing_(Name_LOCAL)"
],
"dataSourcesOn": [{"aleiPrefix": "VIES"
}
],
"featuresOff": ["ENRICH_LEGAL_FORM",
"SHOW_DECISIONS"
],
"featuresOn": ["SHOW_LOOKUP_RESULTS",
"SHOW_BUSINESSPARTNER",
"SHOW_DATA_DEFECTS"
],
"criticalities": [{"businessRuleUrl": "https://meta.cdq.com/Dummy_post_code_detected_(AF)",
"violationLevel": "WARNING"
},
{"businessRuleUrl": "https://meta.cdq.com/Unallowed_pattern_in_name_detected_(AF)",
"violationLevel": "INFO"
}
],
"ruleStatuses": ["RELEASED"
],
"validationProfile": "EU_VAT_QUALIFICATION",
"ruleCategoriesOn": [{"url": "https://cdlplus-bayer.cdq.ch/CH.MEDREG_Monitoring"
}
]
},
"id": "63a1d5a1335faf2f613164c0",
"createdAt": "2022-12-20T15:32:49.579921335Z",
"modifiedAt": "2022-12-20T15:32:49.579949313Z",
"createdBy": "demo"
}

Delete configuration

Deletes a configuration for the current user.

SecurityapiKey

Request

path Parameters

configurationId

required

string (ConfigurationId)

Configuration ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

200

OK.

400

Bad Request.

delete/configurations/businesspartnervalidation/{configurationId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"name": "Demo config",
"configuration": {"validationProfile": "QUICK",
"ruleStatuses": ["RELEASED"
],
"featuresOn": ["BUSINESS_PARTNER_CHECKS"
],
"featuresOff": ["BUSINESS_PARTNER_CHECKS"
],
"ruleCategoriesOn": [{"url": "https://meta.cdq.com/Qualification"
}
],
"ignoredRules": ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"
],
"activatedRules": ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"
],
"criticalities": [{"businessRuleUrl": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))",
"violationLevel": "INFO"
}
],
"dataSourcesOn": [{"prefix": "VIES"
}
],
"dataSourcesOff": [{"prefix": "VIES"
}
],
"violationMessages": [{"businessRuleUrl": "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))",
"violationMessage": "Business Partner identifier is mandatory."
}
]
},
"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
"createdAt": "2024-11-21T16:00:52Z",
"modifiedAt": "2024-11-21T16:00:52Z",
"createdBy": "76248934691294444"
}

Fetch existing configuration

Fetches an existing configuration for the current user.

SecurityapiKey

Request

path Parameters

configurationId

required

string (ConfigurationId)

Configuration ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Responses

200

Configuration updated successful.

get/configurations/businesspartnervalidation/{configurationId}

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"name": "demo config",
"configuration": {"ignoredRules": ["https://meta.cdq.com/Care_of_information_misplaced_(business_partner_name)",
"https://meta.cdq.com/Checkdigit_of_state_tax_number_(Brasil_-_Acre_(AC))"
],
"activatedRules": ["https://meta.cdq.com/Business_partner_name_missing_(Name_LOCAL)"
],
"dataSourcesOn": [{"aleiPrefix": "VIES"
}
],
"featuresOff": ["ENRICH_LEGAL_FORM",
"SHOW_DECISIONS"
],
"featuresOn": ["SHOW_LOOKUP_RESULTS",
"SHOW_BUSINESSPARTNER",
"SHOW_DATA_DEFECTS"
],
"criticalities": [{"businessRuleUrl": "https://meta.cdq.com/Dummy_post_code_detected_(AF)",
"violationLevel": "WARNING"
},
{"businessRuleUrl": "https://meta.cdq.com/Unallowed_pattern_in_name_detected_(AF)",
"violationLevel": "INFO"
}
],
"ruleStatuses": ["RELEASED"
],
"validationProfile": "EU_VAT_QUALIFICATION",
"ruleCategoriesOn": [{"url": "https://cdlplus-bayer.cdq.ch/CH.MEDREG_Monitoring"
}
]
},
"id": "63a1d5a13b5faf2f613164c0",
"createdAt": "2022-12-20T15:32:49.579Z",
"modifiedAt": "2022-12-20T15:32:49.579Z",
"createdBy": "demo"
}

Find current users configuration

Fetches the current users' configuration. If no configuration exists, a default configuration is returned.

SecurityapiKey

Request

query Parameters

defaultConfiguration	boolean Is default workspace configuration of given type. Example: defaultConfiguration=true
limit	integer (Limit) Maximum number of results to return. The default is 100. Example: limit=100
startAfter	string (StartAfter) Start after the given index. Use this to paginate through the results. The first page is returned if this parameter is not provided. Example: startAfter=5712566172571652

Responses

200

Successful operation

get/configurations/businesspartnervalidation

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "0",
"nextStartAfter": "1",
"total": 2,
"values": [{"name": "demo config",
"id": "63a1d4a07c855600fa769329",
"createdAt": "2022-12-20T15:28:32.684Z",
"modifiedAt": "2022-12-20T15:28:32.684Z",
"createdBy": "demo"
},
{"name": "demo config",
"id": "63a1d5a13b5faf2f613164c0",
"createdAt": "2022-12-20T15:32:49.579Z",
"modifiedAt": "2022-12-20T15:32:49.579Z",
"createdBy": "demo"
}
]
}

Update existing configuration

Updates an existing configuration for the current user.

SecurityapiKey

Request

path Parameters

configurationId

required

string (ConfigurationId)

Configuration ID.

Example: c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4

Request Body schema: application/json

object (BusinessPartnerValidationConfiguration)

Configuration of the validation process for a single Business Partner record.

featuresOn

Array of strings (WorkspaceConfigurationUpdateFeaturesOn)

Features to be enabled.

Items Value:	Description
REEVALUATION_ON_CHANGES	Re-evaluates business partners based on changes in the configuration.

Example: ["REEVALUATION_ON_CHANGES"]

name

string

The name of the configuration.

Example: "Custom configuration name"

Responses

200

Configuration updated successful.

400

Bad Request.

put/configurations/businesspartnervalidation/{configurationId}

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"name": "demo config",
"configuration": { }
}

Response samples

application/json

{"name": "demo config",
"id": "63a1d5a13b5faf2f613164c0",
"createdAt": "2022-12-20T15:32:49.579Z",
"modifiedAt": "2022-12-20T15:43:43.158949713Z",
"createdBy": "demo"
}