Used to either create new Business Partners or update existing ones in the Business Partner Storage.
Request to create or update business partners.
OK
{- "dataSource": "648824a691d8d2503d65103e",
- "businessPartners": [
- {
- "id": "63e635235c06b7396330fe40",
- "createdAt": "2024-09-19T13:17:05Z",
- "lastModifiedAt": "2024-09-19T13:17:05Z",
- "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": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG"
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": "Amtsgericht Aachen"
}
], - "categories": [
], - "classifications": [
- {
- "name": "Manufacture of pesticides and other agrochemical products.",
- "code": "20.20Z",
- "type": {
- "name": "NAF 2003",
}
}
], - "status": {
- "type": {
- "name": "In Liquidation",
- "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",
- "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",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}, - "types": [
- {
- "name": "Legal Address",
- "technicalKey": "LEGAL_ADDRESS"
}
]
}
], - "record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
- "partnerProfile": {
- "minorityIndicator": {
- "value": "Social enterprise"
}
}
}
], - "featuresOn": [
- "UPSERT_BY_EXTERNAL_ID"
], - "featuresOff": [
- "UPSERT_BY_EXTERNAL_ID"
]
}
{- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2024-09-19T13:17:05Z",
- "expiresAt": "2024-09-19T13:17:05Z",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-09-19T13:17:05Z",
- "lastUpdatedAt": "2024-09-19T13:17:05Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "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-19T13:17:05Z",
- "configuration": {
- "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}, - "executions": [
- {
- "type": {
- "technicalKey": "TRIGGER"
}, - "frequency": "BI_WEEKLY"
}
], - "validitySpan": {
- "technicalKey": "YEAR"
}, - "createdAt": "2024-09-19T13:17:05Z",
- "createdBy": "76248934691294444",
- "modifiedAt": "2024-09-19T13:17:05Z",
- "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-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "resultItems": [
- {
- "country": "CH",
- "label": "Result Item label",
- "numberOfRecords": "500",
- "type": "Result Item type"
}
], - "validationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
]
}, - "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 Partner.
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. |
OK
{- "addressCurationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "resultItems": [
- {
- "country": "CH",
- "label": "Result Item label",
- "numberOfRecords": "500",
- "type": "Result Item type"
}
], - "validationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
]
}
{- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2024-09-19T13:17:05Z",
- "expiresAt": "2024-09-19T13:17:05Z",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-09-19T13:17:05Z",
- "lastUpdatedAt": "2024-09-19T13:17:05Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "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-19T13:17:05Z",
- "configuration": {
- "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}, - "executions": [
- {
- "type": {
- "technicalKey": "TRIGGER"
}, - "frequency": "BI_WEEKLY"
}
], - "validitySpan": {
- "technicalKey": "YEAR"
}, - "createdAt": "2024-09-19T13:17:05Z",
- "createdBy": "76248934691294444",
- "modifiedAt": "2024-09-19T13:17:05Z",
- "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-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "resultItems": [
- {
- "country": "CH",
- "label": "Result Item label",
- "numberOfRecords": "500",
- "type": "Result Item type"
}
], - "validationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
]
}, - "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 a Business Partner Storage Metadata.
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 |
OK
{- "startAfter": "5712566172571652",
- "limit": "100",
- "total": "67",
- "values": [
- {
- "id": "63e635235c06b7396330fe40",
- "createdAt": "2024-09-19T13:17:05Z",
- "lastModifiedAt": "2024-09-19T13:17:05Z",
- "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": {
- "name": "Local Name",
- "technicalKey": "LOCAL"
}, - "value": "Corporate Data Quality AG"
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "language": {
- "name": "German",
- "technicalKey": "DE"
}
}, - "identifiers": [
- {
- "type": {
- "name": "CH_VAT_ID",
- "technicalKey": "CH_VAT_ID"
}, - "value": "CHE-218.608.886 HR/MWST",
- "issuingBody": "Amtsgericht Aachen"
}
], - "categories": [
], - "classifications": [
- {
- "name": "Manufacture of pesticides and other agrochemical products.",
- "code": "20.20Z",
- "type": {
- "name": "NAF 2003",
}
}
], - "status": {
- "type": {
- "name": "In Liquidation",
- "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",
- "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",
- "technicalKey": "VIES",
- "cdqId": "VIES:PL8660001429"
}, - "language": {
- "name": "German",
- "technicalKey": "DE"
}
}, - "types": [
- {
- "name": "Legal Address",
- "technicalKey": "LEGAL_ADDRESS"
}
]
}
], - "record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
- "partnerProfile": {
- "minorityIndicator": {
- "value": "Social enterprise"
}
}
}
]
}
Read a page of a Business Partner Storage Metadata.
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 |
OK
{- "values": [
- {
- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2024-09-19T13:17:05Z",
- "expiresAt": "2024-09-19T13:17:05Z",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-09-19T13:17:05Z",
- "lastUpdatedAt": "2024-09-19T13:17:05Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "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-19T13:17:05Z",
- "configuration": {
- "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}, - "executions": [
- {
- "type": {
- "technicalKey": null
}, - "frequency": "BI_WEEKLY"
}
], - "validitySpan": {
- "technicalKey": "YEAR"
}, - "createdAt": "2024-09-19T13:17:05Z",
- "createdBy": "76248934691294444",
- "modifiedAt": "2024-09-19T13:17:05Z",
- "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-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "resultItems": [
- {
- "country": "CH",
- "label": "Result Item label",
- "numberOfRecords": "500",
- "type": "Result Item type"
}
], - "validationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
]
}, - "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 a Business Partner Storage Metadata.
OK
{- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2024-09-19T13:17:05Z",
- "expiresAt": "2024-09-19T13:17:05Z",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-09-19T13:17:05Z",
- "lastUpdatedAt": "2024-09-19T13:17:05Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "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-19T13:17:05Z",
- "configuration": {
- "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}, - "executions": [
- {
- "type": {
- "technicalKey": "TRIGGER"
}, - "frequency": "BI_WEEKLY"
}
], - "validitySpan": {
- "technicalKey": "YEAR"
}, - "createdAt": "2024-09-19T13:17:05Z",
- "createdBy": "76248934691294444",
- "modifiedAt": "2024-09-19T13:17:05Z",
- "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-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "resultItems": [
- {
- "country": "CH",
- "label": "Result Item label",
- "numberOfRecords": "500",
- "type": "Result Item type"
}
], - "validationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
]
}, - "status": "FILE_IMPORTED_SUCCESSFULLY",
- "statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
- "sharedWithOrganization": "true",
- "labels": [
- "Custom Storage Name"
]
}
Used to update the results associated with the Business Partners in the Business Partner Storage.
OK
{- "patches": [
- {
- "addressResultPatches": [
- {
- "addressResults": {
- "curationResult": {
- "accuracyIndicator": "5",
- "changes": [
- null
], - "curatedAddress": {
- "id": null,
- "externalId": null,
- "careOf": null,
- "contexts": [ ],
- "country": null,
- "administrativeAreas": [ ],
- "postCode": null,
- "localities": [ ],
- "thoroughfares": [ ],
- "premises": [ ],
- "postalDeliveryPoint": null,
- "geographicCoordinates": null,
- "formattedAddress": null,
- "metadata": 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,
- "lastModifiedAt": null,
- "dataSource": null,
- "externalId": null,
- "disclosed": null,
- "names": [ ],
- "legalForm": null,
- "identifiers": [ ],
- "categories": [ ],
- "classifications": [ ],
- "status": null,
- "metadata": null,
- "addresses": [ ],
- "record": null,
- "partnerProfile": null
}, - "originalBusinessPartner": {
- "id": null,
- "createdAt": null,
- "lastModifiedAt": null,
- "dataSource": null,
- "externalId": null,
- "disclosed": null,
- "names": [ ],
- "legalForm": null,
- "identifiers": [ ],
- "categories": [ ],
- "classifications": [ ],
- "status": null,
- "metadata": null,
- "addresses": [ ],
- "record": null,
- "partnerProfile": 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-19T13:17:05Z",
- "lastModifiedAt": "2024-09-19T13:17:05Z",
- "dataSource": "\"CUSTOM_DATA_SOURCE\" or \"648824a691d8d2503d65103e\"",
- "externalId": "The ID managed in the customer's SAP systems.",
- "disclosed": "false",
- "names": [
- {
- "details": null,
- "language": null,
- "shortName": null,
- "type": null,
- "value": null
}
], - "legalForm": {
- "name": "Aktiengesellschaft",
- "language": {
- "name": null,
- "technicalKey": null
}
}, - "identifiers": [
- {
- "type": null,
- "value": null,
- "issuingBody": null
}
], - "categories": [
- {
- "name": null,
- "url": null,
- "technicalKey": null
}
], - "classifications": [
- {
- "name": null,
- "code": null,
- "type": null
}
], - "status": {
- "type": {
- "name": null,
- "url": null,
- "technicalKey": null
}
}, - "metadata": {
- "status": {
- "recordStatus": null,
- "explanations": [ ]
}, - "sharingStatus": {
- "status": null,
- "description": null
}, - "identityLinks": [
- null
]
}, - "addresses": [
- {
- "id": null,
- "externalId": null,
- "careOf": null,
- "contexts": [ ],
- "country": null,
- "administrativeAreas": [ ],
- "postCode": null,
- "localities": [ ],
- "thoroughfares": [ ],
- "premises": [ ],
- "postalDeliveryPoint": null,
- "geographicCoordinates": null,
- "formattedAddress": null,
- "metadata": null,
- "types": [ ]
}
], - "record": "{\"name\": \"BUSINESSPARTNER_NAME\", ...}",
- "partnerProfile": {
- "minorityIndicator": {
- "value": 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"
}
]
}
{- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2024-09-19T13:17:05Z",
- "expiresAt": "2024-09-19T13:17:05Z",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-09-19T13:17:05Z",
- "lastUpdatedAt": "2024-09-19T13:17:05Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "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-19T13:17:05Z",
- "configuration": {
- "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}, - "executions": [
- {
- "type": {
- "technicalKey": "TRIGGER"
}, - "frequency": "BI_WEEKLY"
}
], - "validitySpan": {
- "technicalKey": "YEAR"
}, - "createdAt": "2024-09-19T13:17:05Z",
- "createdBy": "76248934691294444",
- "modifiedAt": "2024-09-19T13:17:05Z",
- "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-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "resultItems": [
- {
- "country": "CH",
- "label": "Result Item label",
- "numberOfRecords": "500",
- "type": "Result Item type"
}
], - "validationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
]
}, - "status": "FILE_IMPORTED_SUCCESSFULLY",
- "statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
- "sharedWithOrganization": "true",
- "labels": [
- "Custom Storage Name"
]
}
Update a Business Partner Storage Metadata.
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." |
OK
{- "originalFileHeader": [
- "BusinessPartnerId, Name, Address"
], - "status": "FILE_IMPORTED_SUCCESSFULLY",
- "statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage."
}
{- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2024-09-19T13:17:05Z",
- "expiresAt": "2024-09-19T13:17:05Z",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-09-19T13:17:05Z",
- "lastUpdatedAt": "2024-09-19T13:17:05Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "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-19T13:17:05Z",
- "configuration": {
- "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}, - "executions": [
- {
- "type": {
- "technicalKey": "TRIGGER"
}, - "frequency": "BI_WEEKLY"
}
], - "validitySpan": {
- "technicalKey": "YEAR"
}, - "createdAt": "2024-09-19T13:17:05Z",
- "createdBy": "76248934691294444",
- "modifiedAt": "2024-09-19T13:17:05Z",
- "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-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "resultItems": [
- {
- "country": "CH",
- "label": "Result Item label",
- "numberOfRecords": "500",
- "type": "Result Item type"
}
], - "validationReports": [
- {
- "creationTimestamp": "2024-09-19T13:17:05Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
]
}, - "status": "FILE_IMPORTED_SUCCESSFULLY",
- "statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
- "sharedWithOrganization": "true",
- "labels": [
- "Custom Storage Name"
]
}