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"
}
]
}
{- "deleted": "10"
}
Read a page of relations from a Business Partner Storage.
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 Filter by dataSource name or id | ||||
endedAfter | string Find relations which endedAt is after given date. Example: endedAfter=2019-12-31T16:47:00Z | ||||
endedBefore | string Find relations which endedAt is before given date. Example: endedBefore=2019-12-31T16:47:00Z | ||||
externalId | string Filter by externalId | ||||
featureOff | Array of strings (RelationsReadFeatureParam) Features to be turned off:
Example: featureOff=SHOW_BUSINESS_PARTNER_INFORMATION | ||||
featureOn | Array of strings (RelationsReadFeatureParam) Features to be turned on.
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=10 | ||||
startedAfter | string Find relations which startedAt is after given date. Example: startedAfter=2019-12-31T16:47:00Z | ||||
startedBefore | string Find relations which startedAt is before given date Example: startedBefore=2019-12-31T16:47:00Z | ||||
type | string (BusinessPartnerRelationTypeTechnicalKey) Filter by type. Example: type=COMMERCIAL_ULTIMATE |
OK
{- "startAfter": "5712566172571652",
- "nextStartAfter": "5712566172571652",
- "limit": "100",
- "total": "67",
- "values": [
- "Commercial ultimate"
]
}
Upsert Business Partner Relations. When inserting a new relation, 'startedAt' date is set to current date and 'endedAt' date is set to null. When updating a relation, 'endedAt' date is set to current date in existing relation and a new relation is created."
OK
Bad Request
Unauthorized
{- "relations": [
- "Commercial ultimate"
]
}
{- "numberOfProvidedRelations": "500",
- "numberOfInserts": "500",
- "numberOfUpdates": "500",
- "numberOfFailed": "500",
- "failures": [
- {
- "startNodeExternalId": 78643267348,
- "endNodeExternalId": 78643267348,
- "message": "Missing data source ID."
}
]
}