Business Partner Storages (None Public)

Create or update Business PartnersDeprecated

Used to either create new Business Partners or update existing ones in the Business Partner Storage.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

query Parameters

domain required	string Domain. Example: domain=cdq.com
user required	string User. Example: user=username

Request Body schema: application/json
required

Request to create or update business partners.

required

Array of objects (BusinessPartner) [ 1 .. 1000 ] items

List of Business Partners.

dataSource

string (BusinessPartnerDataSource)

Name or ID of a data source. Reflects the associated external system where the record originates from.

Example: "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\""

featuresOff

Array of strings (UpsertFeatureParam)

Features to be deactivated during the upsert.

Items Enum:	Description
UPSERT_BY_EXTERNAL_ID	Updates a Business Partners identified by external ID instead of an insert if the external ID is already present in this storage.
API_ERROR_ON_FAILURES	Throws exception instead of default Upsert Failure Log.
TRANSFORM_RECORD	Transforms record into Business Partner model using the dataMapperDefinition attached to the dataSource. Supported only for batch size up to 250 Business Partners.
ENABLE_SETTINGS	Enables usage of user and organization settings in upsert process. Enabled by default.
ENABLE_ASYNC	Stores data to the storage. Enables asynchronous data processing for transformation, updates, indexing and sharing processes. Requires externalId to be present in the businessPartner. Enabled by default when TRANSFORM_RECORD not used.

Example: ["UPSERT_BY_EXTERNAL_ID"]

featuresOn

Array of strings (UpsertFeatureParam)

Features to be activated during the upsert.

Items Enum:	Description
UPSERT_BY_EXTERNAL_ID	Updates a Business Partners identified by external ID instead of an insert if the external ID is already present in this storage.
API_ERROR_ON_FAILURES	Throws exception instead of default Upsert Failure Log.
TRANSFORM_RECORD	Transforms record into Business Partner model using the dataMapperDefinition attached to the dataSource. Supported only for batch size up to 250 Business Partners.
ENABLE_SETTINGS	Enables usage of user and organization settings in upsert process. Enabled by default.
ENABLE_ASYNC	Stores data to the storage. Enables asynchronous data processing for transformation, updates, indexing and sharing processes. Requires externalId to be present in the businessPartner. Enabled by default when TRANSFORM_RECORD not used.

Example: ["UPSERT_BY_EXTERNAL_ID"]

Responses

200

put/storages/{storageId}/businesspartners

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"businessPartners": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-09-16T14:59:33Z",
"modifiedAt": "2024-09-16T14:59:33Z",
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": "false",
"updateMonitoring": "true",
"updateCommercialMonitoring": [{"type": {"technicalKey": "DNB"
},
"value": "true"
}
],
"metadata": {"sharingStatus": {"status": "SHARED_WITH_NO_MATCH",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
],
"logResultStatuses": [{"processingLogId": "CURATION_LOG",
"triggerProcessedAt": "2024-09-16T14:59:33Z",
"triggerType": {"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {"processedAt": "2024-09-16T14:59:33Z",
"provenance": {"name": null,
"technicalKey": null,
"cdqId": null
},
"type": {"name": null,
"technicalKey": null
}
},
"jobProcessedAt": "2024-09-16T14:59:33Z",
"processedAt": "2024-09-16T14:59:33Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"categories": [{"name": "Limited Liability Company",
"shortName": "LLC",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"technicalKey": "LIMITED"
}
]
},
"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": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": null,
"value": null
}
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-09-16T14:59:33Z",
"validUntil": "2024-09-16T14:59:33Z"
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "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",
"technicalKey": "NAF 2003"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
"technicalKey": "FAX"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2024-09-16T14:59:33Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
}
},
"relations": [{"startedAt": "2024-09-16T14:59:33Z",
"endedAt": "2024-09-16T14:59:33Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2024-09-16T14:59:33Z"
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"addresses": [{"id": "0001",
"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {"language": {"name": "German",
"technicalKey": "DE"
},
"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
}
},
"identifyingName": {"value": "John Doe"
},
"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
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"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",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoints": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": null,
"technicalKey": null
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-09-16T14:59:33Z",
"lastPaymentDate": "2024-09-16T14:59:33Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
}
],
"featuresOn": ["UPSERT_BY_EXTERNAL_ID"
],
"featuresOff": ["UPSERT_BY_EXTERNAL_ID"
]
}

Response samples

application/json

{"id": "648824a691d8d2503d65103e",
"name": "Internal customers",
"eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
"decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
"domain": "BusinessPartner",
"organization": "cdq_monitor",
"user": "johndoe",
"createdAt": "2024-09-16T14:59:33Z",
"expiresAt": "2024-09-16T14:59:33Z",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"dataSources": [{"id": "648824a691d8d2503d65103e",
"createdAt": "2024-09-16T14:59:33Z",
"lastUpdatedAt": "2024-09-16T14:59:33Z",
"name": "Internal customers",
"dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
"dataTransformationDefinitionId": "SAP.ODM",
"prefix": "Custom prefix",
"mappingDisclosure": "true"
}
],
"dataMonitors": [{"id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
"type": {"name": "Augmentation",
"technicalKey": "AUGMENTATION"
},
"dataSources": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers"
}
],
"enabled": "true",
"disabledAt": "2024-09-16T14:59:33Z",
"configuration": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
},
"executions": [{"type": {"technicalKey": "TRIGGER"
},
"frequency": "BI_WEEKLY"
}
],
"validitySpan": {"technicalKey": "YEAR"
},
"createdAt": "2024-09-16T14:59:33Z",
"createdBy": "76248934691294444",
"modifiedAt": "2024-09-16T14:59:33Z",
"modifiedBy": "76248934691294444",
"featuresOn": ["BUILD_REPORT"
]
}
],
"features": {"lookup": {"status": "ENABLED"
},
"updates": {"status": "ENABLED"
},
"sharing": {"status": "ENABLED"
},
"neverExpire": {"status": "ENABLED"
},
"tagsManagedByUpsert": {"status": "ENABLED"
}
},
"numberOfCountries": "12",
"numberOfRecords": "500",
"countryStatistics": [{"countryCode": "CH",
"numberOfRecords": "500"
}
],
"originalFileHeader": ["BusinessPartnerId, Name, Address"
],
"originalFileName": "business-partner.csv",
"results": {"addressCurationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"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-16T14:59:33Z",
"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"
]
}

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-16T14:59:33Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"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-16T14:59:33Z",
"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",
"decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
"domain": "BusinessPartner",
"organization": "cdq_monitor",
"user": "johndoe",
"createdAt": "2024-09-16T14:59:33Z",
"expiresAt": "2024-09-16T14:59:33Z",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"dataSources": [{"id": "648824a691d8d2503d65103e",
"createdAt": "2024-09-16T14:59:33Z",
"lastUpdatedAt": "2024-09-16T14:59:33Z",
"name": "Internal customers",
"dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
"dataTransformationDefinitionId": "SAP.ODM",
"prefix": "Custom prefix",
"mappingDisclosure": "true"
}
],
"dataMonitors": [{"id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
"type": {"name": "Augmentation",
"technicalKey": "AUGMENTATION"
},
"dataSources": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers"
}
],
"enabled": "true",
"disabledAt": "2024-09-16T14:59:33Z",
"configuration": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
},
"executions": [{"type": {"technicalKey": "TRIGGER"
},
"frequency": "BI_WEEKLY"
}
],
"validitySpan": {"technicalKey": "YEAR"
},
"createdAt": "2024-09-16T14:59:33Z",
"createdBy": "76248934691294444",
"modifiedAt": "2024-09-16T14:59:33Z",
"modifiedBy": "76248934691294444",
"featuresOn": ["BUILD_REPORT"
]
}
],
"features": {"lookup": {"status": "ENABLED"
},
"updates": {"status": "ENABLED"
},
"sharing": {"status": "ENABLED"
},
"neverExpire": {"status": "ENABLED"
},
"tagsManagedByUpsert": {"status": "ENABLED"
}
},
"numberOfCountries": "12",
"numberOfRecords": "500",
"countryStatistics": [{"countryCode": "CH",
"numberOfRecords": "500"
}
],
"originalFileHeader": ["BusinessPartnerId, Name, Address"
],
"originalFileName": "business-partner.csv",
"results": {"addressCurationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"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-16T14:59:33Z",
"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 Business PartnersDeprecated

Read a page of a Business Partner Storage Metadata.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

query Parameters

countryCode	Array of strings (CountryShortName) Country code (ISO 3166-1 alpha-2) used to filter the result of business partners returned. Example: countryCode=CH
dataSourceId	Array of strings (BusinessPartnerStorageDataSourceId) Filter by specified Data Source ID. Example: dataSourceId=648824a691d8d2503d65103e
page	integer (Page) >= 0 Default: 0 Current page number. Example: page=1
pageSize	integer <int32> Default: 20 Number of items per page. Example: pageSize=20

Responses

200

get/storages/{storageId}/businesspartners

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "5712566172571652",
"limit": "100",
"total": "67",
"values": [{"id": "63e635235c06b7396330fe40",
"createdAt": "2024-09-16T14:59:33Z",
"modifiedAt": "2024-09-16T14:59:33Z",
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": "false",
"updateMonitoring": "true",
"updateCommercialMonitoring": [{"type": {"technicalKey": "DNB"
},
"value": "true"
}
],
"metadata": {"sharingStatus": {"status": "SHARED_WITH_NO_MATCH",
"description": "UNDER_CONSIDERATION: The business partner will be considered for the sharing process."
},
"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
],
"logResultStatuses": [{"processingLogId": "CURATION_LOG",
"triggerProcessedAt": "2024-09-16T14:59:33Z",
"triggerType": {"name": "CREATED",
"technicalKey": "CREATED"
},
"trigger": {"processedAt": "2024-09-16T14:59:33Z",
"provenance": {"name": null,
"technicalKey": null,
"cdqId": null
},
"type": {"name": null,
"technicalKey": null
}
},
"jobProcessedAt": "2024-09-16T14:59:33Z",
"processedAt": "2024-09-16T14:59:33Z",
"status": "INFO",
"description": "Validation Level"
}
],
"decisionLogResult": {"reviewStatus": "REVIEWED",
"naturalPersonsReviewStatus": "REVIEWED",
"duplicatesReviewStatus": "REVIEWED"
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": "German",
"technicalKey": "DE"
},
"mainAbbreviation": "AG",
"categories": [{"name": "Limited Liability Company",
"shortName": "LLC",
"url": "https://meta.cdq.com/Business_partner/legal_form/category/technical_key/LF001",
"technicalKey": "LIMITED"
}
]
},
"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": {"name": "Amtsgericht Aachen",
"url": "https://meta.cdq.com/Business_partner/identifier/issuing_body",
"technicalKey": "Amtsgericht Aachen",
"jurisdiction": {"country": {"shortName": null,
"value": null
}
}
},
"status": {"name": "ACTIVE",
"technicalKey": "ACTIVE"
}
}
],
"categories": [{"name": "Hotel",
"url": "https://meta.cdq.com/Business_partner/category",
"technicalKey": "HOTEL"
}
],
"status": {"type": {"name": "In Liquidation",
"url": "https://meta.cdq.com/Business_partner/status/type",
"technicalKey": "IN_LIQUIDATION"
},
"officialDenotation": "Good Standing",
"validFrom": "2024-09-16T14:59:33Z",
"validUntil": "2024-09-16T14:59:33Z"
},
"profile": {"minorityIndicator": {"value": "Social enterprise"
},
"classifications": [{"value": "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",
"technicalKey": "NAF 2003"
}
}
],
"phoneNumbers": [{"countryPrefix": "+41",
"number": "71 571 10 40",
"type": {"name": "FAX",
"url": "https://meta.cdq.com/Business_partner/partner_profile/phone_number/type",
"technicalKey": "FAX"
},
"value": "+41 71 571 10 40"
}
],
"websites": [{"url": "https://cdq.com",
"type": {"name": "Corporate Website",
"url": "https://meta.cdq.com/Business_Partner/partner_profile/website/type",
"technicalKey": "WEBSITE_TYPE_CORPORATE"
}
}
],
"contactEmails": [{"value": "developer-portal@cdq.com"
}
],
"tags": [{"value": "Warehouse",
"type": {"technicalKey": "WAREHOUSE"
}
}
],
"vatPayerStatus": {"publicationDate": "2024-09-16T14:59:33Z",
"status": {"name": "RELIABLE",
"technicalKey": "VAT_PAYER_STATUS"
},
"registrationAuthority": {"registrationAuthorityId": "RA000009",
"registrationAuthorityEntityId": "RA000009",
"otherRegistrationAuthorityId": "RA000009"
}
}
},
"relations": [{"startedAt": "2024-09-16T14:59:33Z",
"endedAt": "2024-09-16T14:59:33Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"endNode": {"externalId": "The ID managed in the customer's SAP systems.",
"dataSourceId": "648824a691d8d2503d65103e"
},
"deactivatedAt": "2024-09-16T14:59:33Z"
}
],
"types": [{"name": "Legal Entity",
"url": "https://meta.cdq.com/Business_partner/type",
"technicalKey": "LEGAL_ENTITY"
}
],
"addresses": [{"id": "0001",
"externalId": "1",
"cdqId": "CDQID-123456789",
"version": {"language": {"name": "German",
"technicalKey": "DE"
},
"characterSet": {"name": "International",
"technicalKey": "INTERNATIONAL"
}
},
"identifyingName": {"value": "John Doe"
},
"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
}
}
],
"postCodes": [{"value": "9000",
"type": {"name": null,
"url": null,
"technicalKey": null
}
}
],
"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",
"value": "Lukasstraße 4",
"name": "Lukasstraße",
"direction": "221-bis Baker Street, North",
"language": {"name": null,
"technicalKey": null
}
}
],
"premises": [{"value": "Lukasstraße 4",
"shortName": "Lukasstr. 4",
"number": "4",
"type": {"name": null,
"url": null,
"technicalKey": null
},
"language": {"name": null,
"technicalKey": null
}
}
],
"postalDeliveryPoints": [{"type": {"name": null,
"url": null,
"technicalKey": null
},
"shortName": "St Gallen, Postfach 460",
"number": "460",
"value": "Postfach",
"language": {"name": null,
"technicalKey": null
}
}
],
"geographicCoordinates": {"latitude": "47.439549",
"longitude": "9.395275"
},
"types": [{"name": "Legal Address",
"url": "https://meta.cdq.com/Address/type",
"technicalKey": "LEGAL_ADDRESS"
}
]
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": "CH8800781619278412000",
"internationalBankIdentifier": "KBSGCH22XXX",
"nationalBankAccountIdentifier": "619278412000",
"nationalBankIdentifier": "00781",
"countryCode": "DE",
"vendorPaymentSummary": {"firstPaymentDate": "2024-09-16T14:59:33Z",
"lastPaymentDate": "2024-09-16T14:59:33Z",
"numberOfPayments": "1"
}
}
],
"externalContext": {"identifiers": [{"value": "7250017031",
"type": {"technicalKey": "KUNNR"
}
}
]
}
}
],
"nextStartAfter": "5712566172571652"
}

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

{"values": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers",
"eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
"decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
"domain": "BusinessPartner",
"organization": "cdq_monitor",
"user": "johndoe",
"createdAt": "2024-09-16T14:59:33Z",
"expiresAt": "2024-09-16T14:59:33Z",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"dataSources": [{"id": "648824a691d8d2503d65103e",
"createdAt": "2024-09-16T14:59:33Z",
"lastUpdatedAt": "2024-09-16T14:59:33Z",
"name": "Internal customers",
"dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
"dataTransformationDefinitionId": "SAP.ODM",
"prefix": "Custom prefix",
"mappingDisclosure": "true"
}
],
"dataMonitors": [{"id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
"type": {"name": "Augmentation",
"technicalKey": "AUGMENTATION"
},
"dataSources": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers"
}
],
"enabled": "true",
"disabledAt": "2024-09-16T14:59:33Z",
"configuration": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
},
"executions": [{"type": {"technicalKey": null
},
"frequency": "BI_WEEKLY"
}
],
"validitySpan": {"technicalKey": "YEAR"
},
"createdAt": "2024-09-16T14:59:33Z",
"createdBy": "76248934691294444",
"modifiedAt": "2024-09-16T14:59:33Z",
"modifiedBy": "76248934691294444",
"featuresOn": ["BUILD_REPORT"
]
}
],
"features": {"lookup": {"status": "ENABLED"
},
"updates": {"status": "ENABLED"
},
"sharing": {"status": "ENABLED"
},
"neverExpire": {"status": "ENABLED"
},
"tagsManagedByUpsert": {"status": "ENABLED"
}
},
"numberOfCountries": "12",
"numberOfRecords": "500",
"countryStatistics": [{"countryCode": "CH",
"numberOfRecords": "500"
}
],
"originalFileHeader": ["BusinessPartnerId, Name, Address"
],
"originalFileName": "business-partner.csv",
"results": {"addressCurationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"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-16T14:59:33Z",
"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"
]
}
],
"limit": "100",
"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"total": "67"
}

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",
"decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
"domain": "BusinessPartner",
"organization": "cdq_monitor",
"user": "johndoe",
"createdAt": "2024-09-16T14:59:33Z",
"expiresAt": "2024-09-16T14:59:33Z",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"dataSources": [{"id": "648824a691d8d2503d65103e",
"createdAt": "2024-09-16T14:59:33Z",
"lastUpdatedAt": "2024-09-16T14:59:33Z",
"name": "Internal customers",
"dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
"dataTransformationDefinitionId": "SAP.ODM",
"prefix": "Custom prefix",
"mappingDisclosure": "true"
}
],
"dataMonitors": [{"id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
"type": {"name": "Augmentation",
"technicalKey": "AUGMENTATION"
},
"dataSources": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers"
}
],
"enabled": "true",
"disabledAt": "2024-09-16T14:59:33Z",
"configuration": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
},
"executions": [{"type": {"technicalKey": "TRIGGER"
},
"frequency": "BI_WEEKLY"
}
],
"validitySpan": {"technicalKey": "YEAR"
},
"createdAt": "2024-09-16T14:59:33Z",
"createdBy": "76248934691294444",
"modifiedAt": "2024-09-16T14:59:33Z",
"modifiedBy": "76248934691294444",
"featuresOn": ["BUILD_REPORT"
]
}
],
"features": {"lookup": {"status": "ENABLED"
},
"updates": {"status": "ENABLED"
},
"sharing": {"status": "ENABLED"
},
"neverExpire": {"status": "ENABLED"
},
"tagsManagedByUpsert": {"status": "ENABLED"
}
},
"numberOfCountries": "12",
"numberOfRecords": "500",
"countryStatistics": [{"countryCode": "CH",
"numberOfRecords": "500"
}
],
"originalFileHeader": ["BusinessPartnerId, Name, Address"
],
"originalFileName": "business-partner.csv",
"results": {"addressCurationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"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-16T14:59:33Z",
"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,
"cdqId": null,
"version": null,
"identifyingName": null,
"careOf": null,
"contexts": [ ],
"country": null,
"administrativeAreas": [ ],
"postCodes": [ ],
"localities": [ ],
"thoroughfares": [ ],
"premises": [ ],
"postalDeliveryPoints": [ ],
"geographicCoordinates": null,
"types": [ ]
},
"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,
"createdAt": null,
"modifiedAt": null,
"externalId": null,
"dataSource": null,
"disclosed": null,
"updateMonitoring": null,
"updateCommercialMonitoring": [ ],
"metadata": null,
"record": null,
"names": [ ],
"legalForm": null,
"identifiers": [ ],
"categories": [ ],
"status": null,
"profile": null,
"relations": [ ],
"types": [ ],
"addresses": [ ],
"bankAccounts": [ ],
"externalContext": null
},
"originalBusinessPartner": {"id": null,
"createdAt": null,
"modifiedAt": null,
"externalId": null,
"dataSource": null,
"disclosed": null,
"updateMonitoring": null,
"updateCommercialMonitoring": [ ],
"metadata": null,
"record": null,
"names": [ ],
"legalForm": null,
"identifiers": [ ],
"categories": [ ],
"status": null,
"profile": null,
"relations": [ ],
"types": [ ],
"addresses": [ ],
"bankAccounts": [ ],
"externalContext": null
},
"originalDataDefects": [null
],
"referenceBusinesspartners": [null
],
"remainingDataDefects": [null
]
},
"lookupResults": {"lookupMatches": [null
]
},
"validationResult": {"dataDefects": [null
],
"fixProposals": [null
]
}
},
"id": "0"
}
],
"businessPartnerResults": {"businessPartnerCurationResult": {"curatedBusinessPartner": {"id": "63e635235c06b7396330fe40",
"createdAt": "2024-09-16T14:59:33Z",
"modifiedAt": "2024-09-16T14:59:33Z",
"externalId": "The ID managed in the customer's SAP systems.",
"dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
"disclosed": "false",
"updateMonitoring": "true",
"updateCommercialMonitoring": [{"type": null,
"value": null
}
],
"metadata": {"sharingStatus": {"status": null,
"description": null
},
"identityLinks": [null
],
"logResultStatuses": [null
],
"decisionLogResult": {"reviewStatus": null,
"naturalPersonsReviewStatus": null,
"duplicatesReviewStatus": null
}
},
"record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
"names": [{"type": null,
"value": null,
"shortName": null,
"language": null
}
],
"legalForm": {"name": "Aktiengesellschaft",
"url": "https://meta.cdq.com/Business_partner/legal_form",
"technicalKey": "DE_9866",
"language": {"name": null,
"technicalKey": null
},
"mainAbbreviation": "AG",
"categories": [null
]
},
"identifiers": [{"type": null,
"value": null,
"issuingBody": null,
"status": null
}
],
"categories": [{"name": null,
"url": null,
"technicalKey": null
}
],
"status": {"type": {"name": null,
"url": null,
"technicalKey": null
},
"officialDenotation": "Good Standing",
"validFrom": "2024-09-16T14:59:33Z",
"validUntil": "2024-09-16T14:59:33Z"
},
"profile": {"minorityIndicator": {"value": null
},
"classifications": [null
],
"phoneNumbers": [null
],
"websites": [null
],
"contactEmails": [null
],
"tags": [null
],
"vatPayerStatus": {"publicationDate": null,
"status": null,
"registrationAuthority": null
}
},
"relations": [{"startedAt": null,
"endedAt": null,
"type": null,
"class": null,
"startNode": null,
"endNode": null,
"deactivatedAt": null
}
],
"types": [{"name": null,
"url": null,
"technicalKey": null
}
],
"addresses": [{"id": null,
"externalId": null,
"cdqId": null,
"version": null,
"identifyingName": null,
"careOf": null,
"contexts": [ ],
"country": null,
"administrativeAreas": [ ],
"postCodes": [ ],
"localities": [ ],
"thoroughfares": [ ],
"premises": [ ],
"postalDeliveryPoints": [ ],
"geographicCoordinates": null,
"types": [ ]
}
],
"bankAccounts": [{"internationalBankAccountIdentifier": null,
"internationalBankIdentifier": null,
"nationalBankAccountIdentifier": null,
"nationalBankIdentifier": null,
"countryCode": null,
"vendorPaymentSummary": null
}
],
"externalContext": {"identifiers": [null
]
}
}
},
"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",
"decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
"domain": "BusinessPartner",
"organization": "cdq_monitor",
"user": "johndoe",
"createdAt": "2024-09-16T14:59:33Z",
"expiresAt": "2024-09-16T14:59:33Z",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"dataSources": [{"id": "648824a691d8d2503d65103e",
"createdAt": "2024-09-16T14:59:33Z",
"lastUpdatedAt": "2024-09-16T14:59:33Z",
"name": "Internal customers",
"dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
"dataTransformationDefinitionId": "SAP.ODM",
"prefix": "Custom prefix",
"mappingDisclosure": "true"
}
],
"dataMonitors": [{"id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
"type": {"name": "Augmentation",
"technicalKey": "AUGMENTATION"
},
"dataSources": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers"
}
],
"enabled": "true",
"disabledAt": "2024-09-16T14:59:33Z",
"configuration": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
},
"executions": [{"type": {"technicalKey": "TRIGGER"
},
"frequency": "BI_WEEKLY"
}
],
"validitySpan": {"technicalKey": "YEAR"
},
"createdAt": "2024-09-16T14:59:33Z",
"createdBy": "76248934691294444",
"modifiedAt": "2024-09-16T14:59:33Z",
"modifiedBy": "76248934691294444",
"featuresOn": ["BUILD_REPORT"
]
}
],
"features": {"lookup": {"status": "ENABLED"
},
"updates": {"status": "ENABLED"
},
"sharing": {"status": "ENABLED"
},
"neverExpire": {"status": "ENABLED"
},
"tagsManagedByUpsert": {"status": "ENABLED"
}
},
"numberOfCountries": "12",
"numberOfRecords": "500",
"countryStatistics": [{"countryCode": "CH",
"numberOfRecords": "500"
}
],
"originalFileHeader": ["BusinessPartnerId, Name, Address"
],
"originalFileName": "business-partner.csv",
"results": {"addressCurationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"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-16T14:59:33Z",
"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",
"decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
"domain": "BusinessPartner",
"organization": "cdq_monitor",
"user": "johndoe",
"createdAt": "2024-09-16T14:59:33Z",
"expiresAt": "2024-09-16T14:59:33Z",
"dataMatchingDefinitionId": "6400955811c68a034bcef311",
"dataSources": [{"id": "648824a691d8d2503d65103e",
"createdAt": "2024-09-16T14:59:33Z",
"lastUpdatedAt": "2024-09-16T14:59:33Z",
"name": "Internal customers",
"dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
"dataTransformationDefinitionId": "SAP.ODM",
"prefix": "Custom prefix",
"mappingDisclosure": "true"
}
],
"dataMonitors": [{"id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
"type": {"name": "Augmentation",
"technicalKey": "AUGMENTATION"
},
"dataSources": [{"id": "648824a691d8d2503d65103e",
"name": "Internal customers"
}
],
"enabled": "true",
"disabledAt": "2024-09-16T14:59:33Z",
"configuration": {"id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
},
"executions": [{"type": {"technicalKey": "TRIGGER"
},
"frequency": "BI_WEEKLY"
}
],
"validitySpan": {"technicalKey": "YEAR"
},
"createdAt": "2024-09-16T14:59:33Z",
"createdBy": "76248934691294444",
"modifiedAt": "2024-09-16T14:59:33Z",
"modifiedBy": "76248934691294444",
"featuresOn": ["BUILD_REPORT"
]
}
],
"features": {"lookup": {"status": "ENABLED"
},
"updates": {"status": "ENABLED"
},
"sharing": {"status": "ENABLED"
},
"neverExpire": {"status": "ENABLED"
},
"tagsManagedByUpsert": {"status": "ENABLED"
}
},
"numberOfCountries": "12",
"numberOfRecords": "500",
"countryStatistics": [{"countryCode": "CH",
"numberOfRecords": "500"
}
],
"originalFileHeader": ["BusinessPartnerId, Name, Address"
],
"originalFileName": "business-partner.csv",
"results": {"addressCurationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"description": "Report description",
"name": "Report name",
"type": "Report type",
"url": "https://www.cdq.com"
}
],
"goldenRecordGenerationReports": [{"creationTimestamp": "2024-09-16T14:59:33Z",
"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-16T14:59:33Z",
"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)

Create or update Business PartnersDeprecated

path Parameters

query Parameters

Request Body schema: application/jsonrequired

Modify Results of a Business PartnerDeprecated

path Parameters

Request Body schema: application/jsonrequired

Read a page of Business PartnersDeprecated

path Parameters

query Parameters

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

Request Body schema: application/json
required