Rdificate a custom record. It returns rdf model of the record.
baseURL required | string Base. Example: "http://meta.cdq.com/" |
object JSON object that will be RDFied. Record and jsonRecord cannot be present at the same time. Example: "{'recordId': 'id', 'name': 'demo'}" | |
knowledgeGraphId | string Knowledge Graph that contains required configuration for test cases rdfication process. Example: "kg_1_m_1" |
pathToReferenceId required | string JSON path that can locate attribute, in case of non-existent path selection will fall back to referenceIdTag. Example: "\\fullPath\\recordId" |
record | string Stringified data that will be RDFied. Record and jsonRecord cannot be present at the same time. Example: "{\\\"recordId\\\":\\\"id\\\",\\\"name\\\":\\\"demo\\\"}" |
referenceIdTag required | string Name of the attribute that should be used as a main identifier for all triples generated based on the data sent. Will use first found value of an attribute with given name. Example: "record_id" |
rootPrefix required | string Prefix that is used for generating TTL triples. Single resource URI is created by baseUrl + rootPrefix + encodedJSONPath ex. http://meta.cdq.com/data/name. Example: "data" |
OK
{- "jsonRecord": "{'recordId': 'id', 'name': 'demo'}",
- "record": "{\\\"recordId\\\":\\\"id\\\",\\\"name\\\":\\\"demo\\\"}",
- "referenceIdTag": "record_id",
- "pathToReferenceId": "\\fullPath\\recordId",
- "rootPrefix": "data",
- "knowledgeGraphId": "kg_1_m_1"
}
{- "rdfRecord": "<http://monitor.test.cdq.com/380bdf33-ad17-41bc-a3e5-78b27befdca9> a <http://monitor.test.cdq.com/Record>; <http://monitor.test.cdq.com/Property/Has_record_id> '92912918-a85c-4d77-9f62-3b2ddb57a279'; <http://monitor.test.cdq.com/Property/Name> 'demo' ."
}
Validates a Business Partner against data quality rules.
OK
{- "profile": "QUICK",
- "ruleStatuses": [
- "RELEASED"
], - "featuresOn": [
- "SHOW_LOOKUP_RESULTS"
], - "featuresOff": [
- "SHOW_LOOKUP_RESULTS"
], - "dataSourcesOn": [
- {
- "prefix": "VIES"
}
], - "dataSourcesOff": [
- {
- "prefix": "VIES"
}
], - "vatAtRequestor": "AT123456789",
- "vatDeRequestor": "DE123456789",
- "bzstPrint": "true",
- "validationSource": "VIES",
- "criticalities": [
- {
- "violationLevel": "INFO"
}
], - "configurationId": "6513d25b63cf07787018790a"
}
{- "dataDefects": [
- {
- "properties": [
- {
- "content": "DE12345678",
- "contentSelector": "$.partnerProfile.minorityIndicator.value",
- "name": "Minority Indicator Value",
- "rootConcept": {
- "id": "EU_VAT_ID_DE",
- "idSelector": "businessPartner.identifiers[type.technicalKey=EU_VAT_ID_DE].technicalKey",
- "name": "Address",
}, - "parentConcept": {
- "id": "EU_VAT_ID_DE",
- "idSelector": "businessPartner.identifiers[type.technicalKey=EU_VAT_ID_DE].technicalKey",
- "name": "Address",
}
}
], - "validationSource": "VIES",
- "businessRule": {
- "name": "Identifier unknown (European value added tax identifier (The Netherlands))",
- "ruleStatus": "RELEASED"
}, - "violationLevel": "INFO",
- "violationMessage": "Business Partner identifier is mandatory.",
- "reason": "Identifier is mandatory.",
- "categories": [
], - "errorCode": "400"
}
], - "qualificationResult": {
- "sourceData": [
- {
- "key": "addrz1",
- "value": "CH-9000"
}
], - "formattedSourceData": {
- "code": "ATU12345678",
- "message": "Message to be filled in.",
- "businessPartnerName": "Muster AG",
- "postCodeValue": "9000",
- "thoroughfareValue": "Hauptstrasse",
- "localityValue": "München"
}, - "validatorStatus": "ONLINE",
- "validatorMessage": "VAT ID is valid.",
- "qualifiedBy": "VIES",
- "qualifiedAt": "2024-12-21T01:35:25Z",
- "addressQualification": "QUALIFIED",
- "addressQualificationDetails": {
- "localityQualification": "QUALIFIED",
- "postCodeQualification": "QUALIFIED",
- "thoroughfareNumberQualification": "QUALIFIED",
- "thoroughfareQualification": "QUALIFIED"
}, - "identifierValidity": "VALID",
- "businessPartnerNameQualification": "QUALIFIED",
- "overallQualification": "QUALIFIED"
}, - "lookupResults": [
- {
- "businessPartner": {
- "id": "63e635235c06b7396330fe40",
- "names": [
- {
- "details": "CDQ AG",
- "language": "German",
- "shortName": "CDQ AG",
- "type": "BUSINESS_PARTNER_NAME_TYPE_LOCAL",
- "value": "Corporate Data Quality AG"
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "mainAbbreviation": "AG",
- "technicalKey": "DE_9866"
}, - "identifiers": [
- {
- "issuingBody": "Amtsgericht Aachen",
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST"
}
], - "addresses": [
- {
- "id": "0001",
- "externalId": "1",
- "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": null,
- "shortName": null,
- "type": null
}
], - "postCode": {
- "shortName": "PLZ",
- "type": "Regular",
- "value": "9000"
}, - "localities": [
- {
- "shortName": null,
- "type": null,
- "value": null
}
], - "thoroughfares": [
- {
- "direction": null,
- "number": null,
- "shortName": null,
- "type": null,
- "value": null
}
], - "premises": [
- {
- "value": null,
- "shortName": null,
- "number": null,
- "type": null
}
], - "postalDeliveryPoint": {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}, - "shortName": "St Gallen, Postfach 460",
- "number": "460",
- "value": "Postfach"
}, - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "types": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
]
}
], - "externalId": "The ID managed in the customer's SAP systems.",
- "record": "{name: ..., legalForm: ..., ...}",
- "status": {
- "officialDenotation": "Good Standing",
- "validFrom": "2024-12-21T01:35:25Z",
- "validUntil": "2024-12-21T01:35:25Z",
- "type": {
- "name": "In Liquidation",
- "technicalKey": "IN_LIQUIDATION"
}
}
}, - "address": {
- "id": "0001",
- "externalId": "1",
- "country": {
- "shortName": "CH",
- "value": "Switzerland"
}, - "administrativeAreas": [
- {
- "value": "Sankt Gallen",
- "shortName": "SG",
- "type": {
- "name": "COUNTY",
- "technicalKey": "COUNTY"
}
}
], - "postCode": {
- "shortName": "PLZ",
- "type": "Regular",
- "value": "9000"
}, - "localities": [
- {
- "shortName": "St. Gallen",
- "type": "City",
- "value": "Sankt Gallen"
}
], - "thoroughfares": [
- {
- "direction": "221-bis Baker Street, North",
- "number": "4",
- "shortName": "Lukasstr. 4",
- "type": "Industrial zone",
- "value": "Lukasstraße 4"
}
], - "premises": [
- {
- "value": "Lukasstraße 4",
- "shortName": "Lukasstr. 4",
- "number": "4",
- "type": {
- "name": "Factory",
- "technicalKey": "FACTORY"
}
}
], - "postalDeliveryPoint": {
- "type": {
- "name": "Mailbox",
- "technicalKey": "MAILBOX"
}, - "shortName": "St Gallen, Postfach 460",
- "number": "460",
- "value": "Postfach"
}, - "geographicCoordinates": {
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "types": [
- {
- "name": "Legal Address",
- "technicalKey": "LEGAL_ADDRESS"
}
]
}, - "matchingScore": "0.9",
- "dataSource": "648824a691d8d2503d65103e",
- "cdqId": "VIES:DE119267630"
}
], - "summary": {
- "validationLevel": "ERROR",
- "dataQualityRecordStatus": {
- "name": "No issues found",
- "description": "All rules have been executed, and we have found no data quality issues.",
- "technicalKey": "NO_ISSUES_FOUND"
}, - "action": "FULL_CHECK",
- "statistics": {
- "numberOfInfoDataDefects": "10",
- "numberOfErrorDataDefects": "10",
- "numberOfWarningDataDefects": "10"
}
}, - "debugInfo": {
- "externalServiceResponses": [
- {
- "status": "200",
- "message": "There is no more quota left for this Data Source.",
- "path": "/data-validation/businesspartners/validate",
- "details": "Detailed message",
- "timestamp": "2024-12-21T01:35:25Z",
- "additionalInformation": [
- {
- "key": "requestId",
- "value": "WAPIAAAAYse8yTdE"
}
]
}
], - "businessRulesExecutionSummary": {
- "numberOfRules": "274",
- "numberOfExecutions": "273",
- "numberOfFails": "1",
- "failures": [
- {
- "externalId": "955775",
- "message": "Message to be filled in.",
- "businessRule": {
- "name": "Identifier unknown (European value added tax identifier (The Netherlands))",
- "ruleStatus": "RELEASED"
}
}
], - "warnings": [
- {
- "message": "Message to be filled in."
}
], - "dataSourcesOn": [
- {
- "prefix": "VIES"
}
], - "dataSourcesOff": [
- {
- "prefix": "VIES"
}
], - "ruleStatuses": [
- "RELEASED"
], - "violationLevels": [
- "INFO"
]
}
}, - "identifierResults": [
- {
- "property": {
- "value": "DE119267630",
- "type": "EU_VAT_ID_DE"
}, - "reliabilityLevel": {
- "name": "Identifier existence",
- "value": "4",
- "checks": [
- {
- "name": "Identifier existence",
- "value": "4",
- "status": "OK",
- "validity": {
- "name": "Valid",
- "description": "Identifier check was executed with success, confirms that identifier is meeting requirement for check to pass.",
- "technicalKey": "VALID"
}, - "message": "External service error."
}
]
}, - "qualificationDecisions": [
- {
- "properties": [
- {
- "content": "DE12345678",
- "contentSelector": "$.partnerProfile.minorityIndicator.value",
- "name": "Minority Indicator Value",
- "rootConcept": {
- "id": null,
- "idSelector": null,
- "name": null,
- "url": null
}, - "parentConcept": {
- "id": null,
- "idSelector": null,
- "name": null,
- "url": null
}
}
], - "businessRule": {
- "name": "Identifier unknown (European value added tax identifier (The Netherlands))",
- "ruleStatus": "RELEASED"
}, - "qualificationTarget": "STREET",
- "decision": "VALID",
- "cdqId": "VIES:DE119267630",
- "dataSource": "VIES",
- "identifierValue": "DE119267630",
- "identifierType": "EU_VAT_ID_DE",
- "errorMessage": "Example.",
- "externalServiceResponse": {
- "status": "200",
- "message": "There is no more quota left for this Data Source.",
- "path": "/data-validation/businesspartners/validate",
- "details": "Detailed message",
- "timestamp": "2024-12-21T01:35:25Z",
- "additionalInformation": [
- {
- "key": null,
- "value": null
}
]
}
}
]
}
], - "businessPartner": {
- "names": [
- "Corporate Data Quality AG"
], - "legalForm": "Aktiengesellschaft",
- "identifiers": [
- "VAT identification number"
], - "categories": [
- "Hotel"
], - "status": {
- "officialDenotation": "Good Standing",
- "validFrom": "2024-12-21T01:35:25Z",
- "validUntil": "2024-12-21T01:35:25Z",
- "type": "In Liquidation"
}, - "addresses": [
- "Lukasstraße 4, 9008 St. Gallen"
], - "externalId": "The ID managed in the customer's SAP systems.",
- "profile": {
- "minorityIndicator": "Social enterprise",
- "classifications": [
- "NAF"
], - "phoneNumbers": [
- "+41 71 571 10 40"
], - "websites": [
- "www.cdq.com"
], - "contactEmails": [
- "developer-portal@cdq.com"
], - "tags": [
- {
- "value": "Warehouse",
- "type": {
- "technicalKey": "WAREHOUSE"
}
}
]
}, - "formattedSapRecord": {
- "name1": "CDQ AG",
- "name2": "CDQ AG",
- "name3": "CDQ AG",
- "name4": "CDQ AG",
- "nameCo": "Aktiengesellschaft",
- "legalEntity": "Aktiengesellschaft",
- "legalForm": "Aktiengesellschaft",
- "indSector": "NAF",
- "narp": "Friedrich Nietzsche",
- "stceg": "CHE-218.608.88",
- "stcd1": "CHE-218.608.88",
- "stcd2": "CHE-218.608.88",
- "stcd3": "CHE-218.608.88",
- "stcd4": "CHE-218.608.88",
- "stcd5": "CHE-218.608.88",
- "url": "www.cdq.com",
- "telNumber": "+41 71 571 10 40",
- "country": "Switzerland",
- "countryCode": "CH",
- "region": "Sankt Gallen",
- "regionCodeSap": "9004",
- "regionCode": "9004",
- "county": "Sankt Gallen",
- "countyCode": "9004",
- "township": "Sankt Gallen",
- "townshipCode": "9004",
- "city": "Sankt Gallen",
- "district": "St. Georgen",
- "postalCode": "9000",
- "postalCode3": "9000",
- "street1": "Lukasstraße 4",
- "street2": "Lukasstraße 4",
- "street5": "Lukasstraße 4",
- "houseNum": "4",
- "houseNum2": "4",
- "building": "Office 2",
- "floor": "2",
- "roomnumber": "123",
- "poBoxCountry": "9000",
- "poBoxCity": "9000",
- "poBoxPostalCode": "9000",
- "poBox": "9000",
- "latitude": "47.439549",
- "longitude": "9.395275"
}, - "relations": [
- "Commercial ultimate"
], - "bankAccounts": [
- {
- "internationalBankAccountIdentifier": "CH8800781619278412000",
- "internationalBankIdentifier": "KBSGCH22XXX",
- "nationalBankAccountIdentifier": "619278412000",
- "nationalBankIdentifier": "00781",
- "bank": {
- "name": "Sparda Bank",
- "branch": "Filiale München",
- "address": {
- "localities": [
- "Sankt Gallen"
], - "country": "Switzerland CH",
- "administrativeAreas": [
- "Sankt Gallen"
], - "postCodes": [
- "9000"
], - "thoroughfares": [
- "Lukasstraße 4"
]
}
}, - "countryCode": "DE"
}
], - "types": [
- {
- "name": "Legal Entity",
- "technicalKey": "LEGAL_ENTITY"
}
], - "externalContext": "LIFNR",
- "id": "63e635235c06b7396330fe40",
- "lastModifiedAt": "2024-12-21T01:35:25Z"
}, - "rulesInError": [
- {
- "businessRule": {
- "name": "Identifier unknown (European value added tax identifier (The Netherlands))",
- "ruleStatus": "RELEASED"
}, - "executionStatus": "500",
- "error": {
- "timestamp": "2024-12-21T01:35:25Z",
- "message": "This user is not allowed to access this service.",
- "error": "BAD_REQUEST",
- "path": "/v2/businesspartners/lookup",
- "status": "400",
- "id": "REF_VIES_SERVICE_UNAVAILABLE_300"
}, - "ruleResult": "parentConceptIdSelector = 'businessPartner.identifiers.technicalKey', content = '1633582012931231', parentConceptUrl='https://meta.cdq.com/Business_partner/identifier', recordId = '451ff2f9-8182-43fc-9728-aad9ce62d771', contentSelector = 'businessPartner.identifiers.value', contentSelectorUrl = 'https://meta.cdq.com/Business_partner/identifier/value', parentConceptId = 'EE_BRN'",
- "violationLevel": "INFO",
- "validationSource": "CDQ"
}
]
}