Data Mappers

Transform Business PartnersDeprecated

Use a Data Mapper Definition to transform a list of Business Partners into key-value lists.

SecurityapiKey

Request

path Parameters

required

string (DataMapperDefinitionId)

ID of the Data Mapper Definition.

Example: 6440dba32b30176c5917b1b7

Request Body schema: application/json
required

Records

Array of objects (BusinessPartner)

List of Business Partners.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/datamappers/{id}/transformFields

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartners": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-12-21T01:35:27Z",
"lastModifiedAt": "2024-12-21T01:35:27Z",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"externalId": "The ID managed in the customer's SAP systems.",
"disclosed": "false",
"names": [{"details": "Marketing department",
"language": "DE",
"shortName": "CDQ AG",
"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG"
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": "German",
"technicalKey": "DE"
}
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": "Amtsgericht Aachen"
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"classifications": [{"name": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
}
},
"metadata": {"status": {"recordStatus": "ACCEPTED",
"explanations": ["No errors have been found"
]
},
"sharingStatus": {"status": "UNDER_CONSIDERATION",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
]
},
"addresses": [{"id": "0001",
"externalId": "1",
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"isoCode": "CH-SG",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCode": {"value": "9000",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type",
"technicalKey": "REGULAR"
}
},
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"direction": "221-bis Baker Street, North",
"value": "Lukasstraße 4",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": "Building",
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoint": {"type": "Sankt Gallen, Postfach 460",
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": "German",
"technicalKey": "DE"
}
},
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"district": "City center",
"locality": "Sankt Gallen",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"mailbox": "Postfach 460",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"postOfficeBox": "Postfach 460"
},
"metadata": {"primaryProvenance": {"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"partnerProfile": {"minorityIndicator": {"value": "Social enterprise"
}
}
}
]
}

Response samples

application/json

{"businessPartners": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-12-21T01:35:27Z",
"lastModifiedAt": "2024-12-21T01:35:27Z",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"externalId": "The ID managed in the customer's SAP systems.",
"disclosed": "false",
"names": [{"details": "Marketing department",
"language": "DE",
"shortName": "CDQ AG",
"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG"
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": "German",
"technicalKey": "DE"
}
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": "Amtsgericht Aachen"
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"classifications": [{"name": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
}
},
"metadata": {"status": {"recordStatus": "ACCEPTED",
"explanations": ["No errors have been found"
]
},
"sharingStatus": {"status": "UNDER_CONSIDERATION",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
]
},
"addresses": [{"id": "0001",
"externalId": "1",
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"isoCode": "CH-SG",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCode": {"value": "9000",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type",
"technicalKey": "REGULAR"
}
},
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"direction": "221-bis Baker Street, North",
"value": "Lukasstraße 4",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": "Building",
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoint": {"type": "Sankt Gallen, Postfach 460",
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": "German",
"technicalKey": "DE"
}
},
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"district": "City center",
"locality": "Sankt Gallen",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"mailbox": "Postfach 460",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"postOfficeBox": "Postfach 460"
},
"metadata": {"primaryProvenance": {"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"partnerProfile": {"minorityIndicator": {"value": "Social enterprise"
}
}
}
],
"fieldBusinessPartners": [{"fields": [{"key": "ADDRESS",
"value": "Lukasstrasse 4, 9008 St. Gallen, Switzerland"
}
]
}
]
}

Transform RecordsDeprecated

Use a Data Mapper Definition to transform a list of records into Business Partners.

SecurityapiKey

Request

path Parameters

required

string (DataMapperDefinitionId)

ID of the Data Mapper Definition

Example: 6440dba32b30176c5917b1b7

Request Body schema: application/json
required

Records.

businessPartners

Array of strings (BusinessPartnerId)

List of Business Partners.

Example: ["63e635235c06b7396330fe40"]

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/v3/datamappers/{id}/transformBusinessPartners

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"businessPartners": ["63e635235c06b7396330fe40"
]
}

Response samples

application/json

{"businessPartners": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-12-21T01:35:27Z",
"lastModifiedAt": "2024-12-21T01:35:27Z",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"externalId": "The ID managed in the customer's SAP systems.",
"disclosed": "false",
"names": [{"details": "Marketing department",
"language": "DE",
"shortName": "CDQ AG",
"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG"
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"language": {"name": "German",
"technicalKey": "DE"
}
},
"identifiers": [{"type": {"url": "https://meta.cdq.com/Business_partner/identifier/type",
"name": "CH_VAT_ID",
"technicalKey": "CH_VAT_ID"
},
"value": "CHE-218.608.886 HR/MWST",
"issuingBody": "Amtsgericht Aachen"
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"classifications": [{"name": "Manufacture of pesticides and other agrochemical products.",
"code": "20.20Z",
"type": {"name": "NAF 2003",
"url": "https://meta.cdq.com/Business_partner/partner_profile/classification/type"
}
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
}
},
"metadata": {"status": {"recordStatus": "ACCEPTED",
"explanations": ["No errors have been found"
]
},
"sharingStatus": {"status": "UNDER_CONSIDERATION",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
]
},
"addresses": [{"id": "0001",
"externalId": "1",
"careOf": {"value": "CDQ GmbH c/o Product Department"
},
"contexts": [{"value": "Production hall 7, Storage field 8."
}
],
"country": {"shortName": "CH",
"value": "Switzerland"
},
"administrativeAreas": [{"value": "Sankt Gallen",
"shortName": "SG",
"isoCode": "CH-SG",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postCode": {"value": "9000",
"type": {"name": "Regular",
"url": "https://meta.cdq.com/Address/post_code/type",
"technicalKey": "REGULAR"
}
},
"localities": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St. Gallen",
"value": "Sankt Gallen",
"language": {"name": null,
"technicalKey": null
}
}
],
"thoroughfares": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "Lukasstr. 4",
"number": "4",
"direction": "221-bis Baker Street, North",
"value": "Lukasstraße 4",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": "Building",
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoint": {"type": "Sankt Gallen, Postfach 460",
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": "German",
"technicalKey": "DE"
}
},
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"formattedAddress": {"country": "Switzerland",
"administrativeArea": "Sankt Gallen",
"region": "Sankt Gallen",
"regionCode": "9004",
"district": "City center",
"locality": "Sankt Gallen",
"postCode": "9000",
"thoroughfare": "Lukassstrasse",
"premise": "Lukasstraße 4, Building 2, Floor 3, Room 4",
"mailStation": "US, Pasadena, MAIL STATION 201-6",
"mailbox": "Postfach 460",
"interurbanDeliveryPoint": "Sankt Gallen, Postfach 460",
"postOfficeBox": "Postfach 460"
},
"metadata": {"primaryProvenance": {"name": "VIES",
"url": "https://meta.cdq.com/index.php?title=Property:Has_prefix&limit=500&offset=0&from=&until=&filter=",
"technicalKey": "VIES",
"cdqId": "VIES:PL8660001429"
},
"language": {"name": "German",
"technicalKey": "DE"
}
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"partnerProfile": {"minorityIndicator": {"value": "Social enterprise"
}
}
}
]
}

Data Mappers

Transform Business PartnersDeprecated

path Parameters

Request Body schema: application/jsonrequired

Transform RecordsDeprecated

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required