Delete relations from a storage.
OK
Unauthorized
Forbidden
Not Found
{- "relations": [
- {
- "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"
}, - "type": "COMMERCIAL_ULTIMATE",
- "class": {
- "technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
}
}
]
}{- "deleted": "10"
}Read a page of relations from a Business Partner Storage.
| acting | string (RelationsReadActingParam) Default: "ACTIVE" Find relations that are ACTIVE or INACTIVE.
Example: acting=ACTIVE | ||||||
| classTechnicalKey | string (BusinessPartnerRelationClassTechnicalKey) Filter by class technical key. List of available (classes)[https://meta.cdq.com/Business_partner/relation/class]. Example: classTechnicalKey=BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY | ||||||
| dataSource | string (BusinessPartnerDataSource) Data Source (name or ID) to be measured during calculating statistics. By default, all Data Sources are measured. Example: dataSource="CUSTOM_DATA_SOURCE" or "648824a691d8d2503d65103e" | ||||||
| endedAfter | string Find relations which endedAt is after given date. Example: endedAfter=2024-12-21T01:35:23Z | ||||||
| endedBefore | string Find relations which endedAt is before given date. Example: endedBefore=2024-12-21T01:35:23Z | ||||||
| externalId | string (BusinessPartnerExternalId) Business Partner externalIDs. Example: externalId=The ID managed in the customer's SAP systems. | ||||||
| featureOff | Array of strings (RelationsReadFeatureParam) Features to be deactivated during Relations read.
Example: featureOff=SHOW_BUSINESS_PARTNER_INFORMATION | ||||||
| featureOn | Array of strings (RelationsReadFeatureParam) Features to be activated during Relations read.
Example: featureOn=SHOW_BUSINESS_PARTNER_INFORMATION | ||||||
| limit | integer <int32> >= 1 Default: 500 Number of items to be returned on the page. Example: limit=100 | ||||||
| startAfter | string Only items with an ID greater than the given one will be retrieved. When nextStartAfter provided in the response, should be used instead of the ID as an indicator for a next page. Example: startAfter=5712566172571652 | ||||||
| startedAfter | string Find relations which startedAt is after given date. Example: startedAfter=2024-12-21T01:35:23Z | ||||||
| startedBefore | string Find relations which startedAt is before given date Example: startedBefore=2024-12-21T01:35:23Z | ||||||
| type | string (BusinessPartnerRelationTypeTechnicalKey) Filter by type. Example: type=COMMERCIAL_ULTIMATE |
OK
{- "startAfter": "5712566172571652",
- "nextStartAfter": "5712566172571652",
- "limit": "100",
- "total": "67",
- "values": [
- {
- "startedAt": "2024-12-21T01:35:23Z",
- "endedAt": "2024-12-21T01:35:23Z",
- "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-12-21T01:35:23Z"
}
]
}Insert or update Business Partner Relations. Relations that are not listed in the request are not modified.
In D&B storages, not listed relations of class D&B Hierarchy and one of type [https://meta.cdq.com/Business_partner/relation/type/commercial_ultimate](Commercial Ultimate) or [https://meta.cdq.com/Business_partner/relation/type/domestic_commercial_ultimate](Domestic Commercial Ultimate), are marked as INACTIVE.
Parameters for Relations Upsert Request.
required | Array of objects (BusinessPartnerRelation) [ 1 .. 1000 ] items Batch of Business Partner relations. |
OK
Bad Request
Unauthorized
{- "relations": [
- {
- "startedAt": "2024-12-21T01:35:23Z",
- "endedAt": "2024-12-21T01:35:23Z",
- "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-12-21T01:35:23Z"
}
]
}{- "numberOfProvidedRelations": "10",
- "numberOfInserts": "10",
- "numberOfUpdates": "10",
- "numberOfFailed": "10",
- "failures": [
- {
- "startNodeExternalId": "78643267348",
- "endNodeExternalId": "78643267348",
- "message": "Missing data source ID."
}
]
}