Clear all Business Partners of a data source.
OK
{- "numberOfDeletes": "50",
- "numberOfFailures": "0",
- "failures": [
- {
- "id": "63e635235c06b7396330fe40",
- "dataSource": "648824a691d8d2503d65103e",
- "externalId": "The ID managed in the customer's SAP systems.",
- "message": "This record could not be stored due to timeout."
}
]
}
Create a new data source. Max 100 data sources are allowed.
Warn: If you have an integration with one data source, please check if data source id is included in the upsert request before adding a new data source. Otherwise, adding new data source may lead to upsert failures visible as bad request containing message "No DataSource was provided for the given Business Partners and the storage has more than one attached to it.".
OK
Bad Request
{- "name": "Internal customers",
- "dataMapperDefinitionId": "6400955811c68a034bcef311",
- "prefix": "Custom prefix"
}
{- "id": "648824a691d8d2503d65103e",
- "createdAt": "2020-08-31T16:47+00:00",
- "lastUpdatedAt": "2020-08-31T16:47+00:00",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6400955811c68a034bcef311",
- "prefix": "Custom prefix"
}
Create a new sharing scope. Max 100 sharing scopes are allowed.
When creating sharing scope, all Business Partners from selection scope which are covered become disclosed.
The following table presents the source for disclosed field.
Mapping disclosure | Sharing Scope matches | Source for disclosed |
---|---|---|
true | yes | Mapping disclosure |
true | no | Mapping disclosure |
false | yes | Sharing Scope |
false | no | default: false, otherwise from API request up to V4 |
When source for disclosed field is Sharing Scope, the value is determined only during the creation of a Sharing Scope or Business Partner. Any new update of Business Partner doesn't overwrite the value of disclosed in the Business Partner. To change disclosure of a concrete Business Partner, it has to be requested directly.
OK
Bad Request
{- "description": "Share customers from France.",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e"
}
], - "countries": [
- {
- "shortName": "string"
}
]
}
{- "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
- "description": "Share customers from France.",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers"
}
], - "countries": [
- {
- "shortName": "CH"
}
], - "applyingJob": {
- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "status": "RUNNING",
- "progress": "77"
}
}
If no data source is provided, a minimal data source (name=default and without mapping ID) is attached.
OK
The sent request is malformed.
{- "name": "string",
- "dataMatchingDefinitionId": "string",
- "dataSources": [
- {
- "dataSourceName": "string",
- "dataMapperDefinitionId": "string"
}
], - "featuresOn": [
- "LOOKUP"
], - "sharedWithOrganization": false,
- "labels": [
- "string"
]
}
{- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2020-08-31T16:47+00:00",
- "expiresAt": "2019-08-31T16:47+00:00",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2020-08-31T16:47+00:00",
- "lastUpdatedAt": "2020-08-31T16:47+00:00",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6400955811c68a034bcef311",
- "prefix": "Custom prefix",
- "mappingDisclosure": "true"
}
], - "updateMonitors": [
- {
- "id": "5e580dd08e8b454820e8f67e0",
- "referenceDataSource": "VIES",
- "referenceDataSourceId": "648824a691d8d2503d65103e",
- "affectedProperties": [
- "MINORITY_INDICATOR_VALUE"
], - "affectedDataSourceIds": [
- "648824a691d8d2503d65103e"
]
}
], - "dataMonitors": "[64255349812e8a40bb208a82, 641d8b5594c4330ac2770fea]",
- "features": {
- "lookup": {
- "status": "ENABLED"
}, - "updates": {
- "status": "ENABLED"
}, - "sharing": {
- "status": "ENABLED"
}, - "neverExpire": {
- "status": "ENABLED"
}
}, - "numberOfCountries": "12",
- "numberOfRecords": "500",
- "countryStatistics": [
- {
- "countryCode": "string",
- "numberOfRecords": 0
}
], - "originalFileHeader": [
- "BusinessPartnerId, Name, Address"
], - "originalFileName": "business-partner.csv",
- "results": {
- "addressCurationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
], - "resultItems": [
- {
- "country": "string",
- "label": "string",
- "numberOfRecords": 0,
- "type": "string"
}
], - "validationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
]
}, - "status": "FILE_IMPORTED_SUCCESSFULLY",
- "statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
- "sharedWithOrganization": "true",
- "labels": [
- "Custom Storage Name"
]
}
Create a new update monitor for given storage
OK
Bad Request
{- "affectedDataSources": [
- {
- "id": "648824a691d8d2503d65103e"
}
], - "affectedProperties": [
- "MINORITY_INDICATOR_VALUE"
], - "referenceDataSource": {
- "technicalKey": "BR_RF"
}, - "storageDataSource": {
- "id": "648824a691d8d2503d65103e"
}, - "linkageStrategy": {
- "externalContext": {
- "identifiers": [
- {
- "type": {
- "technicalKey": "KUNNR"
}
}
]
}
}
}
{- "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
- "affectedDataSources": [
- {
- "id": "648824a691d8d2503d65103e"
}
], - "affectedProperties": [
- "MINORITY_INDICATOR_VALUE"
], - "createdAt": "2020-08-31T16:47+00:00",
- "createdBy": "76248934691294444",
- "modifiedAt": "2020-08-31T16:47+00:00",
- "modifiedBy": "76248934691294444",
- "referenceDataSource": {
- "aleiPrefix": "string",
- "technicalKey": "BR_RF"
}, - "storageDataSource": {
- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers"
}, - "linkageStrategy": {
- "externalContext": {
- "identifiers": [
- {
- "type": {
- "technicalKey": "KUNNR"
}
}
]
}
}
}
Delete a data source and its dependencies:
OK
Delete sharing scopes. When deleting sharing scope, all Business Partners from selection scope who are not included in any other sharing scopes, become undisclosed.
OK
{- "sharingScopes": [
- {
- "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf"
}
]
}
{- "sharingScopes": [
- {
- "sharingScope": {
- "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf"
}, - "status": "string"
}
]
}
List all data sources available for update monitoring.
OK
{- "referenceDataSources": [
- {
- "aleiPrefix": "string",
- "technicalKey": "string"
}
]
}
List all sharing scopes of the give storage.
OK
{- "values": [
- {
- "id": "string",
- "description": "string",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers"
}
], - "countries": [
- {
- "shortName": "CH"
}
], - "applyingJob": {
- "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
- "status": "RUNNING",
- "progress": "77"
}
}
], - "limit": "100",
- "startAfter": "5712566172571652",
- "nextStartAfter": "5712566172571652",
- "total": "67"
}
List all storages to which user has access to.
OK
{- "values": [
- {
- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2020-08-31T16:47+00:00",
- "expiresAt": "2019-08-31T16:47+00:00",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2020-08-31T16:47+00:00",
- "lastUpdatedAt": "2020-08-31T16:47+00:00",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6400955811c68a034bcef311",
- "prefix": "Custom prefix",
- "mappingDisclosure": "true"
}
], - "updateMonitors": [
- {
- "id": "5e580dd08e8b454820e8f67e0",
- "referenceDataSource": "VIES",
- "referenceDataSourceId": "648824a691d8d2503d65103e",
- "affectedProperties": [
- "MINORITY_INDICATOR_VALUE"
], - "affectedDataSourceIds": [
- "648824a691d8d2503d65103e"
]
}
], - "dataMonitors": "[64255349812e8a40bb208a82, 641d8b5594c4330ac2770fea]",
- "features": {
- "lookup": {
- "status": "ENABLED"
}, - "updates": {
- "status": "ENABLED"
}, - "sharing": {
- "status": "ENABLED"
}, - "neverExpire": {
- "status": "ENABLED"
}
}, - "numberOfCountries": "12",
- "numberOfRecords": "500",
- "countryStatistics": [
- {
- "countryCode": "string",
- "numberOfRecords": 0
}
], - "originalFileHeader": [
- "BusinessPartnerId, Name, Address"
], - "originalFileName": "business-partner.csv",
- "results": {
- "addressCurationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
], - "resultItems": [
- {
- "country": "string",
- "label": "string",
- "numberOfRecords": 0,
- "type": "string"
}
], - "validationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
]
}, - "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 metadata of a storage
dataSource | string Data Source (name or ID) to be measured during calculating statistics. By default, all Data Sources are measured. |
featuresOn | Array of strings Feature(s) to be used during reading the metadata:
|
OK
{- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2020-08-31T16:47+00:00",
- "expiresAt": "2019-08-31T16:47+00:00",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2020-08-31T16:47+00:00",
- "lastUpdatedAt": "2020-08-31T16:47+00:00",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6400955811c68a034bcef311",
- "prefix": "Custom prefix",
- "mappingDisclosure": "true"
}
], - "updateMonitors": [
- {
- "id": "5e580dd08e8b454820e8f67e0",
- "referenceDataSource": "VIES",
- "referenceDataSourceId": "648824a691d8d2503d65103e",
- "affectedProperties": [
- "MINORITY_INDICATOR_VALUE"
], - "affectedDataSourceIds": [
- "648824a691d8d2503d65103e"
]
}
], - "dataMonitors": "[64255349812e8a40bb208a82, 641d8b5594c4330ac2770fea]",
- "features": {
- "lookup": {
- "status": "ENABLED"
}, - "updates": {
- "status": "ENABLED"
}, - "sharing": {
- "status": "ENABLED"
}, - "neverExpire": {
- "status": "ENABLED"
}
}, - "numberOfCountries": "12",
- "numberOfRecords": "500",
- "countryStatistics": [
- {
- "countryCode": "string",
- "numberOfRecords": 0
}
], - "originalFileHeader": [
- "BusinessPartnerId, Name, Address"
], - "originalFileName": "business-partner.csv",
- "results": {
- "addressCurationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
], - "resultItems": [
- {
- "country": "string",
- "label": "string",
- "numberOfRecords": 0,
- "type": "string"
}
], - "validationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
]
}, - "status": "FILE_IMPORTED_SUCCESSFULLY",
- "statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
- "sharedWithOrganization": "true",
- "labels": [
- "Custom Storage Name"
]
}
Update a Data Source.
dataMapperDefinitionId | string (DataMapperDefinitionId) ID of related Data Mapper Definition that is used for mapping data of this Business Partner Storage. |
name | string (BusinessPartnerStorageDataSourceName) Name of a data source of a storage. |
prefix | string (Prefix) Additional prefix for data source name. |
OK
Bad Request
{- "name": "Internal customers",
- "dataMapperDefinitionId": "6400955811c68a034bcef311",
- "prefix": "Custom prefix"
}
{- "dataSource": {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2020-08-31T16:47+00:00",
- "lastUpdatedAt": "2020-08-31T16:47+00:00",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6400955811c68a034bcef311",
- "prefix": "Custom prefix"
}, - "status": "OK"
}
Update a Business Partner Storage.
dataMatchingDefinitionId | string (DataMatchingDefinitionId) ID of related data matching definition that is used for matching lookup candidates for internal lookup of this Business Partner Storage. |
labels | Array of strings (StorageLabels) <= 10 items unique List of Storages labels. |
name | string <= 50 characters Name of the Business Partner Storage. |
sharedWithOrganization | boolean (SharedWithOrganization) Indicates if this Business Partner Storage is shared with all users of the same organization |
OK
{- "name": "My Storage",
- "labels": [
- "Custom Storage Name"
], - "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "sharedWithOrganization": "true"
}
{- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "decisionLogId": "72d6900fc3wb326088f5d9d91044e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2020-08-31T16:47+00:00",
- "expiresAt": "2019-08-31T16:47+00:00",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2020-08-31T16:47+00:00",
- "lastUpdatedAt": "2020-08-31T16:47+00:00",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6400955811c68a034bcef311",
- "prefix": "Custom prefix",
- "mappingDisclosure": "true"
}
], - "updateMonitors": [
- {
- "id": "5e580dd08e8b454820e8f67e0",
- "referenceDataSource": "VIES",
- "referenceDataSourceId": "648824a691d8d2503d65103e",
- "affectedProperties": [
- "MINORITY_INDICATOR_VALUE"
], - "affectedDataSourceIds": [
- "648824a691d8d2503d65103e"
]
}
], - "dataMonitors": "[64255349812e8a40bb208a82, 641d8b5594c4330ac2770fea]",
- "features": {
- "lookup": {
- "status": "ENABLED"
}, - "updates": {
- "status": "ENABLED"
}, - "sharing": {
- "status": "ENABLED"
}, - "neverExpire": {
- "status": "ENABLED"
}
}, - "numberOfCountries": "12",
- "numberOfRecords": "500",
- "countryStatistics": [
- {
- "countryCode": "string",
- "numberOfRecords": 0
}
], - "originalFileHeader": [
- "BusinessPartnerId, Name, Address"
], - "originalFileName": "business-partner.csv",
- "results": {
- "addressCurationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
], - "resultItems": [
- {
- "country": "string",
- "label": "string",
- "numberOfRecords": 0,
- "type": "string"
}
], - "validationReports": [
- {
- "creationTimestamp": "string",
- "description": "string",
- "name": "string",
- "type": "string",
- "url": "string"
}
]
}, - "status": "FILE_IMPORTED_SUCCESSFULLY",
- "statusMessage": "BusinessPartner batch could not be upserted into Business Partner Storage.",
- "sharedWithOrganization": "true",
- "labels": [
- "Custom Storage Name"
]
}