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": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "prefix": "Custom prefix"
}
{- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-11-22T13:20:20Z",
- "lastUpdatedAt": "2024-11-22T13:20:20Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "prefix": "Custom prefix"
}
Delete a data source and its dependencies:
OK
List all Business Partner Storages of the user's organization.
OK
{- "page": "1",
- "numberOfPages": "10",
- "pageSize": "100",
- "total": "67",
- "values": [
- {
- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2024-11-22T13:20:20Z",
- "expiresAt": "2024-11-22T13:20:20Z",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-11-22T13:20:20Z",
- "lastUpdatedAt": "2024-11-22T13:20:20Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "prefix": "Custom prefix",
- "mappingDisclosure": "true"
}
], - "dataMonitors": [
- {
- "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
- "frequency": "BI_WEEKLY",
- "type": {
- "name": "Augmentation",
- "technicalKey": "AUGMENTATION"
}, - "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers"
}
], - "enabled": true,
- "disabledAt": "2024-11-22T13:20:20Z",
- "configuration": {
- "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}
}
], - "features": {
- "lookup": {
- "status": "ENABLED"
}, - "updates": {
- "status": "ENABLED"
}, - "sharing": {
- "status": "ENABLED"
}, - "neverExpire": {
- "status": "ENABLED"
}
}, - "numberOfCountries": "12",
- "numberOfRecords": "500",
- "countryStatistics": [
- {
- "countryCode": "CH",
- "numberOfRecords": "500"
}
], - "originalFileHeader": [
- "BusinessPartnerId,Name,Address"
], - "originalFileName": "business-partner.csv",
- "results": {
- "addressCurationReports": [
- {
- "creationTimestamp": "2024-11-22T13:20:20Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "2024-11-22T13:20:20Z",
- "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-11-22T13:20:20Z",
- "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 metadata of a Business Partner Storage.
OK
{- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2024-11-22T13:20:20Z",
- "expiresAt": "2024-11-22T13:20:20Z",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-11-22T13:20:20Z",
- "lastUpdatedAt": "2024-11-22T13:20:20Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "prefix": "Custom prefix",
- "mappingDisclosure": "true"
}
], - "dataMonitors": [
- {
- "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
- "frequency": "BI_WEEKLY",
- "type": {
- "name": "Augmentation",
- "technicalKey": "AUGMENTATION"
}, - "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers"
}
], - "enabled": true,
- "disabledAt": "2024-11-22T13:20:20Z",
- "configuration": {
- "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}
}
], - "features": {
- "lookup": {
- "status": "ENABLED"
}, - "updates": {
- "status": "ENABLED"
}, - "sharing": {
- "status": "ENABLED"
}, - "neverExpire": {
- "status": "ENABLED"
}
}, - "numberOfCountries": "12",
- "numberOfRecords": "500",
- "countryStatistics": [
- {
- "countryCode": "CH",
- "numberOfRecords": "500"
}
], - "originalFileHeader": [
- "BusinessPartnerId,Name,Address"
], - "originalFileName": "business-partner.csv",
- "results": {
- "addressCurationReports": [
- {
- "creationTimestamp": "2024-11-22T13:20:20Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "2024-11-22T13:20:20Z",
- "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-11-22T13:20:20Z",
- "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 Data Source.
OK
Bad Request
{- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "prefix": "Custom prefix"
}
{- "dataSource": {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-11-22T13:20:20Z",
- "lastUpdatedAt": "2024-11-22T13:20:20Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "prefix": "Custom prefix"
}, - "status": "OK"
}
This endpoint is deprecated. Please use
Update all data sources of a given storage.
Note: all data sources that are expected to remain in the storage must be included on a list.
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
{- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-11-22T13:20:20Z",
- "lastUpdatedAt": "2024-11-22T13:20:20Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "prefix": "Custom prefix"
}
]
}
{- "created": "4",
- "updated": "0",
- "failed": "4"
}
Update a Business Partner Storage.
OK
{- "name": "My Storage",
- "labels": [
- "Custom Storage Name"
], - "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "sharedWithOrganization": "true"
}
{- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers",
- "eventStoreId": "72d6900fce6b326123f5d9d91049e3e6",
- "domain": "BusinessPartner",
- "organization": "cdq_monitor",
- "user": "johndoe",
- "createdAt": "2024-11-22T13:20:20Z",
- "expiresAt": "2024-11-22T13:20:20Z",
- "dataMatchingDefinitionId": "6400955811c68a034bcef311",
- "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "createdAt": "2024-11-22T13:20:20Z",
- "lastUpdatedAt": "2024-11-22T13:20:20Z",
- "name": "Internal customers",
- "dataMapperDefinitionId": "6440dba32b30176c5917b1b7",
- "dataTransformationDefinitionId": "6440dba32b30176c5917b1b7",
- "prefix": "Custom prefix",
- "mappingDisclosure": "true"
}
], - "dataMonitors": [
- {
- "id": "bfdfd6f7-562f-4d4a-921f-e68cba60d5cf",
- "frequency": "BI_WEEKLY",
- "type": {
- "name": "Augmentation",
- "technicalKey": "AUGMENTATION"
}, - "dataSources": [
- {
- "id": "648824a691d8d2503d65103e",
- "name": "Internal customers"
}
], - "enabled": true,
- "disabledAt": "2024-11-22T13:20:20Z",
- "configuration": {
- "id": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
}
}
], - "features": {
- "lookup": {
- "status": "ENABLED"
}, - "updates": {
- "status": "ENABLED"
}, - "sharing": {
- "status": "ENABLED"
}, - "neverExpire": {
- "status": "ENABLED"
}
}, - "numberOfCountries": "12",
- "numberOfRecords": "500",
- "countryStatistics": [
- {
- "countryCode": "CH",
- "numberOfRecords": "500"
}
], - "originalFileHeader": [
- "BusinessPartnerId,Name,Address"
], - "originalFileName": "business-partner.csv",
- "results": {
- "addressCurationReports": [
- {
- "creationTimestamp": "2024-11-22T13:20:20Z",
- "description": "Report description",
- "name": "Report name",
- "type": "Report type",
}
], - "goldenRecordGenerationReports": [
- {
- "creationTimestamp": "2024-11-22T13:20:20Z",
- "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-11-22T13:20:20Z",
- "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"
]
}