This API 1 provides services to upload, manipulate and download businesspartner data in the CDL Cloud.
Data Exchange API (5)
Download OpenAPI description
Languages
Servers
Production
https://api.cdq.com/data-exchange/rest/
Bodyapplication/jsonrequired
cmd
Detailed description of a Job.
Example: "I started this job to improve quality of our data."
Unique identifier for a Data Source of the Storage.
If set, only the records that belong to the data source identified by this ID are transformed. By default, all records of the Business Partner Storage (means from all data sources) are transformed.
Example: "648824a691d8d2503d65103e"
List of countries for which the records should be transformed.
Unique identifier of the Storage.
Example: "72d6900fce6b326088f5d9d91049e3e6"
ID of related Data Mapper Definition that is used for mapping data of this Business Partner Storage.
Example: "6440dba32b30176c5917b1b7"
Unique identifier for a data transformation definition.
Example: "SAP.ODM"
Processes transformation of records starting from the ID 'startAfter'.
Example: "NjI4ZGNkZjAzYjlkMjY4NjhlNjQxNDRm"
List of Business Partner IDs to be transformed.
Example: ["63e635235c06b7396330fe40"]
| Items Enum Value | Description |
|---|---|
| ENABLE_EXTERNAL_ID_UPDATE | Enables to update external ID of a Business Partner. |
| UPSERT_CHANGES_ONLY | Performs transformation only for business partners, for which changes in the mapping are relevant. By default, all records of the storage are transformed. |
Example: ["UPSERT_CHANGES_ONLY"]
- Production
https://api.cdq.com/data-exchange/rest/jobs/transformationjobs
curl -i -X POST \
https://api.cdq.com/data-exchange/rest/jobs/transformationjobs \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"dataSourceId": "YOUR_DATA_SOURCE_ID",
"storageId": "YOUR_DATA_MIRROR_ID",
"featuresOn": [
"UPSERT_CHANGES_ONLY"
]
}'OK
Detailed description of a Job.
Example: "I started this job to improve quality of our data."
Date of modification (ISO 8601-compliant).
Example: "2025-08-19T06:23:16Z"
Job execution status.
| Enum Value | Description |
|---|---|
| ARCHIVED | Job has been archived. |
| UNKNOWN | Job becomes in unknown status. |
| CREATED | Job has been created. |
| PERSISTED | Job metadata has been persisted. |
| SCHEDULED | Job has been scheduled for execution. |
| WAITING | Job is waiting for being scheduled. |
| COULDNT_START | Job could not be started. |
| RUNNING | Job is being executed. |
| FINISHED | Job has finished. |
| DIED | Job was scheduled and started running but died unexpectedly. |
Example: "RUNNING"
The status message contains the error message if the transformation job failed.
Example: "DataSource [5e2874fb8d2a7400011acee1] has no DataMapperDefinition attached and no alternative dataMapperDefinitionId was passed to the job"
Unique identifier of the Storage.
Example: "72d6900fce6b326088f5d9d91049e3e6"
Unique identifier for a Data Source of the Storage.
Example: "648824a691d8d2503d65103e"
ID of related Data Mapper Definition that is used for mapping data of this Business Partner Storage.
Example: "6440dba32b30176c5917b1b7"
Unique identifier for a data transformation definition.
Example: "SAP.ODM"
Response
application/json
{ "id": "35f23c03-1c22-45fe-9484-3ffe769325de", "domain": "BusinessPartner", "name": "Process vendor data.", "description": "I started this job to improve quality of our data.", "createdBy": "76248934691294444", "createdAt": "2025-08-19T06:23:16Z", "modifiedAt": "2025-08-19T06:23:16Z", "progress": "77", "status": "RUNNING", "statusMessage": "DataSource [5e2874fb8d2a7400011acee1] has no DataMapperDefinition attached and no alternative dataMapperDefinitionId was passed to the job", "storageId": "72d6900fce6b326088f5d9d91049e3e6", "dataSourceId": "648824a691d8d2503d65103e", "dataMapperDefinitionId": "6440dba32b30176c5917b1b7", "dataTransformationDefinitionId": "SAP.ODM", "featuresOn": [ "UPSERT_CHANGES_ONLY" ], "result": { "statistics": { … } } }
Request
After you have started a transformation job, you will receive a job id in the response.
{
"id" : "<ID>"
}Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED the transformation is done, and you are able to verify the result in your storage.
Security
apiKey
- Production
https://api.cdq.com/data-exchange/rest/jobs/transformationjobs/{id}
curl -i -X GET \
https://api.cdq.com/data-exchange/rest/jobs/transformationjobs/35f23c03-1c22-45fe-9484-3ffe769325de \
-H 'X-API-KEY: YOUR_API_KEY_HERE'OK
Detailed description of a Job.
Example: "I started this job to improve quality of our data."
Date of modification (ISO 8601-compliant).
Example: "2025-08-19T06:23:16Z"
Job execution status.
| Enum Value | Description |
|---|---|
| ARCHIVED | Job has been archived. |
| UNKNOWN | Job becomes in unknown status. |
| CREATED | Job has been created. |
| PERSISTED | Job metadata has been persisted. |
| SCHEDULED | Job has been scheduled for execution. |
| WAITING | Job is waiting for being scheduled. |
| COULDNT_START | Job could not be started. |
| RUNNING | Job is being executed. |
| FINISHED | Job has finished. |
| DIED | Job was scheduled and started running but died unexpectedly. |
Example: "RUNNING"
The status message contains the error message if the transformation job failed.
Example: "DataSource [5e2874fb8d2a7400011acee1] has no DataMapperDefinition attached and no alternative dataMapperDefinitionId was passed to the job"
Unique identifier of the Storage.
Example: "72d6900fce6b326088f5d9d91049e3e6"
Unique identifier for a Data Source of the Storage.
Example: "648824a691d8d2503d65103e"
ID of related Data Mapper Definition that is used for mapping data of this Business Partner Storage.
Example: "6440dba32b30176c5917b1b7"
Unique identifier for a data transformation definition.
Example: "SAP.ODM"
Response
application/json
{ "id": "35f23c03-1c22-45fe-9484-3ffe769325de", "domain": "BusinessPartner", "name": "Process vendor data.", "description": "I started this job to improve quality of our data.", "createdBy": "76248934691294444", "createdAt": "2025-08-19T06:23:16Z", "modifiedAt": "2025-08-19T06:23:16Z", "progress": "77", "status": "RUNNING", "statusMessage": "DataSource [5e2874fb8d2a7400011acee1] has no DataMapperDefinition attached and no alternative dataMapperDefinitionId was passed to the job", "storageId": "72d6900fce6b326088f5d9d91049e3e6", "dataSourceId": "648824a691d8d2503d65103e", "dataMapperDefinitionId": "6440dba32b30176c5917b1b7", "dataTransformationDefinitionId": "SAP.ODM", "featuresOn": [ "UPSERT_CHANGES_ONLY" ], "result": { "statistics": { … } } }
- Production
https://api.cdq.com/data-exchange/rest/v3/datamappers/{id}/transform
curl -i -X POST \
https://api.cdq.com/data-exchange/rest/v3/datamappers/6440dba32b30176c5917b1b7/transform \
-H 'Content-Type: application/json' \
-H 'X-API-KEY: YOUR_API_KEY_HERE' \
-d '{
"recordsAsJsonString": [
"{\"address\": \"Musterstrasse 1, 12345 Musterstadt\"}"
]
}'OK
A CDQ ID identifies a business partner uniquely in the context of the Corporate Data League.
Example: "63e635235c06b7396330fe40"
Date of modification (ISO 8601-compliant).
Example: "2025-08-19T06:23:16Z"
Arbitrary identifier type to mark customer IDs that are "external" from CDQ's perspective. This is the identifier a customer provides to identify its records.
Example: "The ID managed in the customer's SAP systems."
Name or ID of a data source. Reflects the associated external system where the record originates from.
Example: "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\""
A flag to indicate whether the business partner should participate in the sharing or not. If 'true' this business partner might be used to create a new entry or update an existing entry in the community pool. Otherwise, it will not be considered for the sharing process. For more details, you can read about Sharing Scopes.
Example: "false"
A flag to indicate whether the Business Partner should receive updates from non-commercial Reference Data Sources or not. If 'true' this Business Partner will receive updates since the change from 'false'. If 'false' this Business Partner will not receive any new updates since the change. If not provided, the previous value will not be changed. By default, Update Monitoring is activated.
Example: "true"
Enabling update commercial monitoring has 2 possibilities:
- via Data Mapper Definition: include mapping of updateCommercialMonitoring in the Data Mapper Definition
- via direct Business Partner model upload: fill complete Business Partner model and
updateCommercialMonitoring. Null/undefinedupdateCommercialMonitoringresults in protection of this setup from the previous upsert. Empty or filledupdateCommercialMonitoringresults in data transition that may link or unlink to / from respective commercial Reference Data Source
Note: follow the approach that is currently used in your storage integration.
Stringified JSON of an individual Business Partner record. Characters: backslash \ and double quote " must be escaped (respectively: \\\\ and \"). Fields containing . are unallowed. Maximum size: 15MB.
Example: "{\"name\": \"BUSINESSPARTNER_NAME\", ...}"
The legal form of a business partner/type/legal entity is the form it takes in the eyes of the law governing it. The legal form of a company is the general type it may legally use to identify itself according to the local, regional, national, or international law governing it. This is normally reflected in the ending abbreviation after the company's name (e.g. AG, Inc., LLC, S.A.).
Describes the status of a business partner with respect to its level of activity (e.g. out of business) or legally relevant conditions (e.g. in liquidation).
Additional documentation can be found here.
List of Relations. Insert or update Business Partner Relations. Relations that are not listed in the request and start in the current business partner, are marked as INACTIVE.
In D&B storages, only not listed relations of class D&B Hierarchy and one of type [https://meta.cdq.com/Business_partner/relation/type/direct_legal_relation](Direct Legal Relation), [https://meta.cdq.com/Business_partner/relation/type/domestic_legal_ultimate_relation](Domestic Legal Ultimate Relation) or [https://meta.cdq.com/Business_partner/relation/type/global_legal_ultimate_relation](Global Legal Ultimate Relation), are marked as INACTIVE.
Represents additional context information that is external to the main Business Partner data.
Response
application/json
[ { "id": "63e635235c06b7396330fe40", "createdAt": "2025-08-19T06:23:16Z", "modifiedAt": "2025-08-19T06:23:16Z", "externalId": "The ID managed in the customer's SAP systems.", "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"", "disclosed": "false", "updateMonitoring": "true", "updateCommercialMonitoring": [ … ], "metadata": { … }, "record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}", "names": [ … ], "legalForm": { … }, "identifiers": [ … ], "categories": [ … ], "status": { … }, "profile": { … }, "relations": [ … ], "types": [ … ], "addresses": [ … ], "bankAccounts": [ … ], "externalContext": { … } } ]