Relations

Delete relations

Delete relations from a storage.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

Array of objects (BusinessPartnerRelationDelete)

List of relations to delete.

Responses

200

401

Unauthorized

403

Forbidden

404

Not Found

post/v4/storages/{storageId}/relations/delete

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"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"
}
}
]
}

Response samples

application/json

{"deleted": "10"
}

Initialize Storage relations

Initialize relations in a Business Partner Storage.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

post/v4/storages/{storageId}/relations

Request samples

curl
Python
Java
Node.js

List Relations

Read a page of relations from a Business Partner Storage.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

query Parameters

acting

string (RelationsReadActingParam)

Default: "ACTIVE"

Find relations that are ACTIVE or INACTIVE.

Enum:	Description
ACTIVE	Only active relations.
INACTIVE	Only inactive relations.

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-11-22T13:20:00Z

endedBefore

string

Find relations which endedAt is before given date.

Example: endedBefore=2024-11-22T13:20:00Z

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.

Items Value:	Description
SHOW_BUSINESS_PARTNER_INFORMATION	Allows to switch fetching business partner details to improve performance. By default, turned on.

Example: featureOff=SHOW_BUSINESS_PARTNER_INFORMATION

featureOn

Array of strings (RelationsReadFeatureParam)

Features to be activated during Relations read.

Items Value:	Description
SHOW_BUSINESS_PARTNER_INFORMATION	Allows to switch fetching business partner details to improve performance. By default, 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=5712566172571652

startedAfter

string

Find relations which startedAt is after given date.

Example: startedAfter=2024-11-22T13:20:00Z

startedBefore

string

Find relations which startedAt is before given date

Example: startedBefore=2024-11-22T13:20:00Z

type

string (BusinessPartnerRelationTypeTechnicalKey)

Filter by type.

Example: type=COMMERCIAL_ULTIMATE

Responses

200

get/v4/storages/{storageId}/relations

Request samples

curl
Python
Java
Node.js

Response samples

application/json

{"startAfter": "5712566172571652",
"nextStartAfter": "5712566172571652",
"limit": "100",
"total": "67",
"values": [{"startedAt": "2024-11-22T13:20:00Z",
"endedAt": "2024-11-22T13:20:00Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": "FR.RC:5664645",
"startNodeDataSource": "648824a691d8d2503d65103e",
"startNodeBusinessPartner": {"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"addresses": [{"country": {"shortName": "CH",
"value": "Switzerland"
},
"postCodes": [{"value": null,
"type": null
}
],
"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
]
}
],
"metadata": {"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
]
}
},
"endNode": "FR.RC:5664645",
"endNodeDataSource": "648824a691d8d2503d65103e",
"endNodeBusinessPartner": {"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"addresses": [{"country": {"shortName": "CH",
"value": "Switzerland"
},
"postCodes": [{"value": null,
"type": null
}
],
"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
]
}
],
"metadata": {"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
]
}
},
"deactivatedAt": "2024-11-22T13:20:00Z"
}
]
}

Upsert Business Partner Relations

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.

SecurityapiKey

Request

path Parameters

storageId

required

string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6

Request Body schema: application/json
required

Parameters for Relations Upsert Request.

required

Array of objects (BusinessPartnerRelation) [ 1 .. 1000 ] items

Batch of Business Partner relations.

Responses

200

400

Bad Request

401

Unauthorized

put/v4/storages/{storageId}/relations

Request samples

Payload
curl
Python
Java
Node.js

application/json

{"relations": [{"startedAt": "2024-11-22T13:20:00Z",
"endedAt": "2024-11-22T13:20:00Z",
"type": {"name": "Commercial ultimate",
"technicalKey": "COMMERCIAL_ULTIMATE"
},
"class": {"name": "CDQ Hierarchy",
"technicalKey": "BUSINESS_PARTNER_RELATION_CLASS_CDQ_HIERARCHY"
},
"startNode": "FR.RC:5664645",
"startNodeDataSource": "648824a691d8d2503d65103e",
"startNodeBusinessPartner": {"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"addresses": [{"country": {"shortName": "CH",
"value": "Switzerland"
},
"postCodes": [{"value": null,
"type": null
}
],
"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
]
}
],
"metadata": {"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
]
}
},
"endNode": "FR.RC:5664645",
"endNodeDataSource": "648824a691d8d2503d65103e",
"endNodeBusinessPartner": {"names": [{"type": {"url": "https://meta.cdq.com/Business_partner/name/type",
"name": "Local Name",
"technicalKey": "LOCAL"
},
"value": "Corporate Data Quality AG",
"shortName": "CDQ AG",
"language": {"name": "German",
"technicalKey": "DE"
}
}
],
"addresses": [{"country": {"shortName": "CH",
"value": "Switzerland"
},
"postCodes": [{"value": null,
"type": null
}
],
"localities": [{"type": null,
"shortName": null,
"value": null,
"language": null
}
],
"thoroughfares": [{"type": null,
"shortName": null,
"number": null,
"value": null,
"name": null,
"direction": null,
"language": null
}
]
}
],
"metadata": {"identityLinks": [{"linkId": "6465f2492bdcd350159a79d6",
"cdqId": "VIES:PL8660001429",
"addressId": "0",
"externalAddressId": "123456789"
}
]
}
},
"deactivatedAt": "2024-11-22T13:20:00Z"
}
]
}

Response samples

application/json

{"numberOfProvidedRelations": "10",
"numberOfInserts": "10",
"numberOfUpdates": "10",
"numberOfFailed": "10",
"failures": [{"startNodeExternalId": "78643267348",
"endNodeExternalId": "78643267348",
"message": "Missing data source ID."
}
]
}

Relations

Delete relations

path Parameters

Request Body schema: application/jsonrequired

Initialize Storage relations

path Parameters

List Relations

path Parameters

query Parameters

Upsert Business Partner Relations

path Parameters

Request Body schema: application/jsonrequired

Request Body schema: application/json
required

Request Body schema: application/json
required