Create Data Mapper Definition

Create a Data Mapper Definition which is used to map data (i.e. in the format from the database) to the CDQ data model.

Data mapper definition consists of:

inputMapping - definition how to map businessPartner.record to CDQ data model
outputMapping - definition how to map CDQ data model to the target model

Business partner can be mapped via businessPartnerAttributeMappings. The following values of attribute mapping rules:

as targetAttributes for inputMapping
as sourceAttributes for outputMapping (please remember they are case sensitive)

can be mapped to Business Partner attributes:

businessPartner.dataSource
businessPartner.externalId
businessPartner.disclosed - special attribute. When defined in a mapping, takes over the decision for disclosing records in data source this Data Mapper Definition is assigned to. When source attribute is mapped from record, the mapping takes the value. If the attribute is missing, disclosed is set to false.
businessPartner.names[0-10].value
businessPartner.names[0-10].shortName
businessPartner.names[0-10].language
businessPartner.names[0-10].type
businessPartner.names
businessPartner.legalForm.name
businessPartner.legalForm.categories[0-4].technicalKey
businessPartner.categories
businessPartner.identifiers[0-49].value
businessPartner.identifiers[0-49].type
businessPartner.identifiers[0-49].issuingBody.name
businessPartner.identifiers[0-49].issuingBody - mapped to issuingBody.technicalKey
businessPartner.identifiers[0-49].status
businessPartner.identifiers
businessPartner.externalContext.identifiers[0-49].value
businessPartner.externalContext.identifiers[0-49].type
businessPartner.externalContext.identifiers

The index of typed concepts: names and identifiers, is not a final position of concept in the CDQ data model - this is a grouping indicator for a set of concept properties.

In Names mapping, in case none of names is typed LOCAL and exists any name with empty type or not filled type.technicalKey, it becomes name of type LOCAL.

Addresses can be mapped via addressesAttributeMappings. Address receives id property coming from an index of the collection of AttributeMappingRules. The following values of attribute mapping rules

as targetAttributes for inputMapping
as sourceAttributes for outputMapping

can be mapped to address attributes:

address.externalId
address.version.language
address.version.characterSet
address.careOf.value
address.identifyingName.value
address.country.value
address.country.shortName
address.administrativeAreas
address.administrativeAreas[0-4].value
address.administrativeAreas[0-4].shortName
address.administrativeAreas[0-4].type
address.postCodes
address.postCodes[0-4].value
address.postCodes[0-4].type
address.localities
address.localities[0-4].value
address.localities[0-4].shortName
address.localities[0-4].type
address.thoroughfares
address.thoroughfares[0-4].value
address.thoroughfares[0-4].shortName
address.thoroughfares[0-4].number
address.thoroughfares[0-4].type
address.premises
address.premises[0-4].value
address.premises[0-4].shortName
address.premises[0-4].number
address.premises[0-4].type
address.postalDeliveryPoints
address.postalDeliveryPoints[0-4].value
address.postalDeliveryPoints[0-4].shortName
address.postalDeliveryPoints[0-4].number
address.postalDeliveryPoints[0-4].type
address.geographicCoordinates.latitude
address.geographicCoordinates.longitude
address.contexts
address.contexts[0-4]

SecurityapiKey

Request

Request Body schema: application/json
required

Request to create a new Data Mapper Definition.

required	object (BusinessPartnerMappingRule) Maps a Business Partner data from raw data to CDQ data model.
labels	Array of strings Labels to categorize the Data Mapper Definition. Example: ["Custom Data Mapper Label"]
name required	string Name of the Data Mapper Definition. Example: "Custom Data Mapper Definition"
	object (BusinessPartnerMappingRule) Maps a Business Partner data from raw data to CDQ data model.
shareWithOrganization	boolean Toggle to enable that the Data Mapper Definition is shared with the whole organization. Example: "true"
	Array of objects (ValueMapping) List of value mappings.

Responses

200

post/datamapperdefinitions

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"name": "Custom Data Mapper Definition",
"labels": ["Custom Data Mapper Label"
],
"shareWithOrganization": "true",
"valueMappings": [{"sourceValue": "en",
"targetValue": "INTERNATIONAL",
"targetAttribute": "address.version.characterSet"
}
],
"inputMapping": {"businessPartnerAttributeMappings": [{"sourceConstant": "LOCAL",
"sourceAttributes": ["Name"
],
"targetAttributes": ["businessPartner.names[0].value"
],
"targetAttributeTypes": ["BUSINESS_PARTNER_NAME_TYPE_LOCAL"
],
"countryScopes": ["DE"
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [{"type": "UPPER_CASE",
"parameters": [{"key": null,
"value": null
}
]
}
]
}
],
"addressesAttributeMappings": [[{"sourceConstant": "LOCAL",
"sourceAttributes": ["Name"
],
"targetAttributes": ["businessPartner.names[0].value"
],
"targetAttributeTypes": ["BUSINESS_PARTNER_NAME_TYPE_LOCAL"
],
"countryScopes": ["DE"
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [{"type": "UPPER_CASE",
"parameters": [null
]
}
]
}
]
]
},
"outputMapping": {"businessPartnerAttributeMappings": [{"sourceConstant": "LOCAL",
"sourceAttributes": ["Name"
],
"targetAttributes": ["businessPartner.names[0].value"
],
"targetAttributeTypes": ["BUSINESS_PARTNER_NAME_TYPE_LOCAL"
],
"countryScopes": ["DE"
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [{"type": "UPPER_CASE",
"parameters": [{"key": null,
"value": null
}
]
}
]
}
],
"addressesAttributeMappings": [[{"sourceConstant": "LOCAL",
"sourceAttributes": ["Name"
],
"targetAttributes": ["businessPartner.names[0].value"
],
"targetAttributeTypes": ["BUSINESS_PARTNER_NAME_TYPE_LOCAL"
],
"countryScopes": ["DE"
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [{"type": "UPPER_CASE",
"parameters": [null
]
}
]
}
]
]
}
}

Response samples

application/json

{"id": "6440dba32b30176c5917b1b7",
"createdAt": "2025-02-21T08:27:54Z",
"createdBy": "76248934691294444",
"lastUpdatedAt": "2025-02-21T08:27:54Z",
"modifiedAt": "2025-02-21T08:27:55Z",
"modifiedBy": "76248934691294444",
"creatorUsername": "john.doe",
"creatorOrganization": "cdq",
"shareWithOrganization": "true",
"labels": ["Custom Storage Name"
],
"name": "Custom name of Data Mapper",
"valueMappings": [{"sourceValue": "en",
"targetValue": "INTERNATIONAL",
"targetAttribute": "address.version.characterSet"
}
],
"inputMapping": {"businessPartnerAttributeMappings": [{"sourceConstant": "LOCAL",
"sourceAttributes": ["Name"
],
"targetAttributes": ["businessPartner.names[0].value"
],
"targetAttributeTypes": ["BUSINESS_PARTNER_NAME_TYPE_LOCAL"
],
"countryScopes": ["DE"
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [{"type": "UPPER_CASE",
"parameters": [{"key": null,
"value": null
}
]
}
]
}
],
"addressesAttributeMappings": [[{"sourceConstant": "LOCAL",
"sourceAttributes": ["Name"
],
"targetAttributes": ["businessPartner.names[0].value"
],
"targetAttributeTypes": ["BUSINESS_PARTNER_NAME_TYPE_LOCAL"
],
"countryScopes": ["DE"
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [{"type": "UPPER_CASE",
"parameters": [null
]
}
]
}
]
]
},
"outputMapping": {"businessPartnerAttributeMappings": [{"sourceConstant": "LOCAL",
"sourceAttributes": ["Name"
],
"targetAttributes": ["businessPartner.names[0].value"
],
"targetAttributeTypes": ["BUSINESS_PARTNER_NAME_TYPE_LOCAL"
],
"countryScopes": ["DE"
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [{"type": "UPPER_CASE",
"parameters": [{"key": null,
"value": null
}
]
}
]
}
],
"addressesAttributeMappings": [[{"sourceConstant": "LOCAL",
"sourceAttributes": ["Name"
],
"targetAttributes": ["businessPartner.names[0].value"
],
"targetAttributeTypes": ["BUSINESS_PARTNER_NAME_TYPE_LOCAL"
],
"countryScopes": ["DE"
],
"selectionType": "COMMA",
"separationType": "LENGTH",
"isMandatoryAttribute": "true",
"valueMapping": "INTERNATIONAL",
"defaultValue": "GB",
"transformations": [{"type": "UPPER_CASE",
"parameters": [null
]
}
]
}
]
]
}
}

Create Data Mapper Definition

Request Body schema: application/jsonrequired

Request Body schema: application/json
required