Knowledge Base

Tutorials

Instructions

API Catalogue

Bankaccount Data API

Data Clinic API

Data Compliance API

Data Curation API

Data Exchange API

Quickstart

Resources

Data Exchange API

Analytics

Business Partner Storages

Business Partner Storages (None Public)

patch

Modify Results of a Business Partner

get

Read a page of storage metadata

get

Read Storage Metadata

patch

Update results for Business Partners

patch

Update storage metadata

Data Matching API

Data Validation API

Email Analysis API

Identity Management API

Knowledge Graph API

Metadata API

Product Identification API

Reference Data API

Vendor Extensions

Salesforce API

SAP DQM API

SAP ODM API

SAP BN API

Business Partner Storages (None Public)

Modify Results of a Business PartnerDeprecated

Modify Results of a Business Partner.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

patch

	Array of objects (Report) List of Address Curation Reports.
	Array of objects (Report) List of Golden Record Generation Reports.
	Array of objects (ResultItem) List of Result Items.
	Array of objects (Report) List of Validation Reports.

Responses

200

patch/storages/{storageId}/results

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"addressCurationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"resultItems": [{"country": "CH",
"label": "Result Item label",
"numberOfRecords": "500",
"type": "Result Item type"
}
],
"validationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
]
}

Response samples

application/json

{"id": "648824a691d8d2503d65103e",
"name": "Internal customers",
"eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
"domain": "BusinessPartner",
"organization": "cdq_monitor",
"user": "johndoe",
"createdAt": "2024-09-19T13:17:17Z",
"expiresAt": "2024-09-19T13:17:17Z",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"dataSources": [{"id": "648824a691d8d2503d65103e",
"createdAt": "2024-09-19T13:17:17Z",
"lastUpdatedAt": "2024-09-19T13:17:17Z",
"name": "Internal customers",
"dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
"dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
"prefix": "Custom prefix",
"mappingDisclosure": "true"
}
],
"dataMonitors": [{"id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
"frequency": "BI_WEEKLY",
"type": {"name": "Augmentation",
"technicalKey": "AUGMENTATION"
},
"dataSources": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers"
}
],
"enabled": "true",
"disabledAt": "2024-09-19T13:17:17Z",
"configuration": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}
}
],
"features": {"lookup": {"status": "ENABLED"
},
"updates": {"status": "ENABLED"
},
"sharing": {"status": "ENABLED"
},
"neverExpire": {"status": "ENABLED"
}
},
"numberOfCountries": "12",
"numberOfRecords": "500",
"countryStatistics": [{"countryCode": "CH",
"numberOfRecords": "500"
}
],
"originalFileHeader": ["BusinessPartnerId,Name,Address"
],
"originalFileName": "business-partner.csv",
"results": {"addressCurationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"resultItems": [{"country": "CH",
"label": "Result Item label",
"numberOfRecords": "500",
"type": "Result Item type"
}
],
"validationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
]
},
"status": "FILE_IMPORTED_SUCCESSFULLY",
"statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
"sharedWithOrganization": "true",
"labels": ["Custom Storage Name"
]
}

Read a page of storage metadataDeprecated

Read a page of a Business Partner Storage Metadata.

SecurityapiKey

Request

query Parameters

domain required	string Domain. Example: domain=cdq.com
page	integer <int32> Default: 0 Current page number. Example: page=0
pageSize	integer <int32> Default: 20 Number of items per page. Example: pageSize=20
sort	string Defines the attributes to sort by. Supported are in (createdAt), separated by comma (,). Sort "+" means ascending, "-" means descending. Default sort (when no + or - set) is ascending. Example: sort=-createdAt
user required	string User. Example: user=username

Responses

200

get/storages/metadata

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"page": "1",
"numberOfPages": "10",
"pageSize": "100",
"total": "67",
"values": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers",
"eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
"domain": "BusinessPartner",
"organization": "cdq_monitor",
"user": "johndoe",
"createdAt": "2024-09-19T13:17:17Z",
"expiresAt": "2024-09-19T13:17:17Z",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"dataSources": [{"id": "648824a691d8d2503d65103e",
"createdAt": "2024-09-19T13:17:17Z",
"lastUpdatedAt": "2024-09-19T13:17:17Z",
"name": "Internal customers",
"dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
"dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
"prefix": "Custom prefix",
"mappingDisclosure": "true"
}
],
"dataMonitors": [{"id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
"frequency": "BI_WEEKLY",
"type": {"name": "Augmentation",
"technicalKey": "AUGMENTATION"
},
"dataSources": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers"
}
],
"enabled": "true",
"disabledAt": "2024-09-19T13:17:17Z",
"configuration": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}
}
],
"features": {"lookup": {"status": "ENABLED"
},
"updates": {"status": "ENABLED"
},
"sharing": {"status": "ENABLED"
},
"neverExpire": {"status": "ENABLED"
}
},
"numberOfCountries": "12",
"numberOfRecords": "500",
"countryStatistics": [{"countryCode": "CH",
"numberOfRecords": "500"
}
],
"originalFileHeader": ["BusinessPartnerId,Name,Address"
],
"originalFileName": "business-partner.csv",
"results": {"addressCurationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"resultItems": [{"country": "CH",
"label": "Result Item label",
"numberOfRecords": "500",
"type": "Result Item type"
}
],
"validationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
]
},
"status": "FILE_IMPORTED_SUCCESSFULLY",
"statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
"sharedWithOrganization": "true",
"labels": ["Custom Storage Name"
]
}
]
}

Read Storage MetadataDeprecated

Read a Business Partner Storage Metadata.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Responses

200

get/storages/{storageId}/metadata

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"id": "648824a691d8d2503d65103e",
"name": "Internal customers",
"eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
"domain": "BusinessPartner",
"organization": "cdq_monitor",
"user": "johndoe",
"createdAt": "2024-09-19T13:17:17Z",
"expiresAt": "2024-09-19T13:17:17Z",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"dataSources": [{"id": "648824a691d8d2503d65103e",
"createdAt": "2024-09-19T13:17:17Z",
"lastUpdatedAt": "2024-09-19T13:17:17Z",
"name": "Internal customers",
"dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
"dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
"prefix": "Custom prefix",
"mappingDisclosure": "true"
}
],
"dataMonitors": [{"id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
"frequency": "BI_WEEKLY",
"type": {"name": "Augmentation",
"technicalKey": "AUGMENTATION"
},
"dataSources": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers"
}
],
"enabled": "true",
"disabledAt": "2024-09-19T13:17:17Z",
"configuration": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}
}
],
"features": {"lookup": {"status": "ENABLED"
},
"updates": {"status": "ENABLED"
},
"sharing": {"status": "ENABLED"
},
"neverExpire": {"status": "ENABLED"
}
},
"numberOfCountries": "12",
"numberOfRecords": "500",
"countryStatistics": [{"countryCode": "CH",
"numberOfRecords": "500"
}
],
"originalFileHeader": ["BusinessPartnerId,Name,Address"
],
"originalFileName": "business-partner.csv",
"results": {"addressCurationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"resultItems": [{"country": "CH",
"label": "Result Item label",
"numberOfRecords": "500",
"type": "Result Item type"
}
],
"validationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
]
},
"status": "FILE_IMPORTED_SUCCESSFULLY",
"statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
"sharedWithOrganization": "true",
"labels": ["Custom Storage Name"
]
}

Update results for Business PartnersDeprecated

Used to update the results associated with the Business Partners in the Business Partner Storage.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

patches

Array of objects (BusinessPartnerResultPatch)

List of Business Partner Result Patches.

Responses

200

patch/storages/{storageId}/businesspartners/results

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"patches": [{"addressResultPatches": [{"addressResults": {"curationResult": {"accuracyIndicator": "5",
"changes": [null
],
"curatedAddress": {"id": null,
"externalId": null,
"addressTypes": [ ],
"careOf": null,
"context": [ ],
"country": null,
"administrativeArea": null,
"postCode": null,
"locality": null,
"thoroughfare": null,
"premise": null,
"postalDeliveryPoint": null,
"geographicCoordinates": null,
"formattedAddress": null,
"results": null
},
"curationLevel": "LEVEL_4",
"requestSimilarity": {"geoCoordinates": null,
"locality": null,
"overall": null,
"postCode": null,
"thoroughfare": null
},
"response": {"message": null,
"status": null,
"timestamp": null
}
},
"goldenRecordGenerationResult": {"explanations": [null
],
"goldenRecord": {"id": null,
"disclosed": null,
"names": [ ],
"legalForm": null,
"identifiers": [ ],
"categories": [ ],
"classifications": [ ],
"companyStatus": null,
"status": null,
"results": null,
"addresses": [ ],
"externalId": null,
"dataSource": null,
"record": null
},
"originalBusinessPartner": {"id": null,
"disclosed": null,
"names": [ ],
"legalForm": null,
"identifiers": [ ],
"categories": [ ],
"classifications": [ ],
"companyStatus": null,
"status": null,
"results": null,
"addresses": [ ],
"externalId": null,
"dataSource": null,
"record": null
},
"originalDataDefects": [null
],
"referenceBusinesspartners": [null
],
"remainingDataDefects": [null
]
},
"lookupResults": {"lookupMatches": [null
]
},
"validationResult": {"dataDefects": [null
],
"fixProposals": [null
]
}
},
"id": "0"
}
],
"businessPartnerResults": {"businessPartnerCurationResult": {"curatedBusinessPartner": {"id": "63e635235c06b7396330fe40",
"disclosed": "false",
"names": [{"details": null,
"language": null,
"shortname": null,
"type": null,
"value": null
}
],
"legalForm": "Aktiengesellschaft",
"identifiers": [{"type": null,
"value": null
}
],
"categories": ["HOTEL"
],
"classifications": [{"code": null,
"label": null,
"type": null
}
],
"companyStatus": "ACTIVE",
"status": {"explanations": [null
],
"recordStatus": "ACCEPTED"
},
"results": { },
"addresses": [{"id": null,
"externalId": null,
"addressTypes": [ ],
"careOf": null,
"context": [ ],
"country": null,
"administrativeArea": null,
"postCode": null,
"locality": null,
"thoroughfare": null,
"premise": null,
"postalDeliveryPoint": null,
"geographicCoordinates": null,
"formattedAddress": null,
"results": null
}
],
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}"
}
},
"categorizationResult": {"categories": [{"categorized": "true",
"key": "CDQ.BP.INDUSTRY",
"label": "Industry",
"score": "0.8"
}
]
},
"validationResult": {"dataDefects": [{"attributes": [null
],
"businessRule": "Deprecated",
"entity": "Deprecated",
"errorCode": "0",
"fixProposal": "Deprecated",
"fixProposalJson": "Deprecated",
"violationLevel": "NO_DEFECT",
"violationMessage": "Business partner misses an optional D-U-N-S number."
}
],
"fixProposals": [{"addresses": [null
],
"identifiers": [null
],
"names": [null
]
}
]
}
},
"id": "63e635235c06b7396330fe40"
}
]
}

Response samples

application/json

{"id": "648824a691d8d2503d65103e",
"name": "Internal customers",
"eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
"domain": "BusinessPartner",
"organization": "cdq_monitor",
"user": "johndoe",
"createdAt": "2024-09-19T13:17:17Z",
"expiresAt": "2024-09-19T13:17:17Z",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"dataSources": [{"id": "648824a691d8d2503d65103e",
"createdAt": "2024-09-19T13:17:17Z",
"lastUpdatedAt": "2024-09-19T13:17:17Z",
"name": "Internal customers",
"dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
"dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
"prefix": "Custom prefix",
"mappingDisclosure": "true"
}
],
"dataMonitors": [{"id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
"frequency": "BI_WEEKLY",
"type": {"name": "Augmentation",
"technicalKey": "AUGMENTATION"
},
"dataSources": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers"
}
],
"enabled": "true",
"disabledAt": "2024-09-19T13:17:17Z",
"configuration": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}
}
],
"features": {"lookup": {"status": "ENABLED"
},
"updates": {"status": "ENABLED"
},
"sharing": {"status": "ENABLED"
},
"neverExpire": {"status": "ENABLED"
}
},
"numberOfCountries": "12",
"numberOfRecords": "500",
"countryStatistics": [{"countryCode": "CH",
"numberOfRecords": "500"
}
],
"originalFileHeader": ["BusinessPartnerId,Name,Address"
],
"originalFileName": "business-partner.csv",
"results": {"addressCurationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"resultItems": [{"country": "CH",
"label": "Result Item label",
"numberOfRecords": "500",
"type": "Result Item type"
}
],
"validationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
]
},
"status": "FILE_IMPORTED_SUCCESSFULLY",
"statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
"sharedWithOrganization": "true",
"labels": ["Custom Storage Name"
]
}

Update storage metadataDeprecated

Update a Business Partner Storage Metadata.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

storageMetadataModifyRequest

originalFileHeader	Array of strings List of headers used for a modification of metadata. Example: ["BusinessPartnerId, Name, Address"]
status	string (StorageMetadataStatus) Status of a Business Partner Storage. Example: "FILE_IMPORTED_SUCCESSFULLY"
statusMessage	string (StorageMetadataStatusMessage) Details related to status. Example: "BusinessPartner batch could not be upserted into Business Partner Storage."

Responses

200

patch/storages/{storageId}/metadata

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"originalFileHeader": ["BusinessPartnerId, Name, Address"
],
"status": "FILE_IMPORTED_SUCCESSFULLY",
"statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage."
}

Response samples

application/json

{"id": "648824a691d8d2503d65103e",
"name": "Internal customers",
"eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
"domain": "BusinessPartner",
"organization": "cdq_monitor",
"user": "johndoe",
"createdAt": "2024-09-19T13:17:17Z",
"expiresAt": "2024-09-19T13:17:17Z",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"dataSources": [{"id": "648824a691d8d2503d65103e",
"createdAt": "2024-09-19T13:17:17Z",
"lastUpdatedAt": "2024-09-19T13:17:17Z",
"name": "Internal customers",
"dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
"dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
"prefix": "Custom prefix",
"mappingDisclosure": "true"
}
],
"dataMonitors": [{"id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
"frequency": "BI_WEEKLY",
"type": {"name": "Augmentation",
"technicalKey": "AUGMENTATION"
},
"dataSources": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers"
}
],
"enabled": "true",
"disabledAt": "2024-09-19T13:17:17Z",
"configuration": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}
}
],
"features": {"lookup": {"status": "ENABLED"
},
"updates": {"status": "ENABLED"
},
"sharing": {"status": "ENABLED"
},
"neverExpire": {"status": "ENABLED"
}
},
"numberOfCountries": "12",
"numberOfRecords": "500",
"countryStatistics": [{"countryCode": "CH",
"numberOfRecords": "500"
}
],
"originalFileHeader": ["BusinessPartnerId,Name,Address"
],
"originalFileName": "business-partner.csv",
"results": {"addressCurationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"resultItems": [{"country": "CH",
"label": "Result Item label",
"numberOfRecords": "500",
"type": "Result Item type"
}
],
"validationReports": [{"creationTimestamp": "2024-09-19T13:17:17Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
]
},
"status": "FILE_IMPORTED_SUCCESSFULLY",
"statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
"sharedWithOrganization": "true",
"labels": ["Custom Storage Name"
]
}

Business Partner Storages (None Public)

Modify Results of a Business PartnerDeprecated

path Parameters

Request Body schema: application/jsonrequired

Read a page of storage metadataDeprecated

query Parameters

Read Storage MetadataDeprecated

path Parameters

Update results for Business PartnersDeprecated

path Parameters

Request Body schema: application/jsonrequired

Update storage metadataDeprecated

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required