Create 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"
}