Skip to content

Data Exchange API (5)

This API 1 provides services to upload, manipulate and download businesspartner data in the CDL Cloud.

Download OpenAPI description
api-v5.json
api-v5.yaml
Languages
Servers
Production

https://api.cdq.com/data-exchange/rest/

Seed Updates

Manages operations such as creating, updating, or transforming Business Partner data to ensure that the information is current and accurate.

Operations

Analytics

Provides functionalities for analyzing and processing Business Partner data, enabling users to gain insights and perform various analytical operations on the data.

Operations

Business Partner Storages

Provides functionalities for creating, retrieving, updating and deleting Business Partner storage, as well as managing associated data sources and data monitors.

Operations

Business Partners

Provides functionalities for creating, retrieving, updating, and deleting Business Partner records, as well as performing various operations such as lookup and upsert.

Operations

Data Import

Provides functionalities for uploading external data and enabling users to enhance and update their Business Partner records with new information.

Operations

Data Mapping

Provides functionalities for defining and managing data mappings, enabling users to transform and map raw data into structured formats suitable for processing and analysis.

Operations

Data Monitors

Provides functionalities for creating, retrieving, updating and deleting data monitors.

Operations

Data Transformation

Provides functionalities for converting raw data into structured formats.

Operations

DNB Storages

Provides functionalities for creating, retrieving, updating and deleting DNB storage, as well as managing associated data sources and data monitors.

Operations

Files

Provides functionalities for uploading, downloading and deleting files.

Operations

Data Mappers

Provides functionalities for transforming raw data into structured Business Partner data using predefined data mapper definitions. This allows users to convert various data formats into a standardized format suitable for processing and analysis.

Operations

Relations

Manages relationships between Business Partners.

Operations

Initialize Storage relations

Request

Initialize relations in a Business Partner Storage.

Security
apiKey
Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
curl -i -X POST \
  https://api.cdq.com/data-exchange/rest/v4/storages/72d6900fce6b326088f5d9d91049e3e6/relations \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

No Content

List Relations

Request

Read a page of relations from a Business Partner Storage.

Security
apiKey
Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Query
startAfterstring

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
limitinteger(int32)>= 1

Number of items to be returned on the page.

Default 500
Example: limit=100
featureOnArray of strings(RelationsReadFeatureParam)

Features to be activated during Relations read.

Items ValueDescription
SHOW_BUSINESS_PARTNER_INFORMATION

Allows to switch fetching business partner details to improve performance. By default, turned on.

Example: featureOn=SHOW_BUSINESS_PARTNER_INFORMATION
featureOffArray of strings(RelationsReadFeatureParam)

Features to be deactivated during Relations read.

Items ValueDescription
SHOW_BUSINESS_PARTNER_INFORMATION

Allows to switch fetching business partner details to improve performance. By default, turned on.

Example: featureOff=SHOW_BUSINESS_PARTNER_INFORMATION
externalIdstring(BusinessPartnerExternalId)

Business Partner externalIDs.

Example: externalId=The ID managed in the customer's SAP systems.
dataSourcestring(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"
typestring(BusinessPartnerRelationTypeTechnicalKey)

Filter by type.

Example: type=COMMERCIAL_ULTIMATE
classTechnicalKeystring(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
endedAfterstring

Find relations which endedAt is after given date.

Example: endedAfter=2025-08-19T06:23:16Z
endedBeforestring

Find relations which endedAt is before given date.

Example: endedBefore=2025-08-19T06:23:16Z
startedAfterstring

Find relations which startedAt is after given date.

Example: startedAfter=2025-08-19T06:23:16Z
startedBeforestring

Find relations which startedAt is before given date

Example: startedBefore=2025-08-19T06:23:16Z
actingstring(RelationsReadActingParam)

Find relations that are ACTIVE or INACTIVE.

Default "ACTIVE"
Enum ValueDescription
ACTIVE

Only active relations.

INACTIVE

Only inactive relations.

Example: acting=ACTIVE
curl -i -X GET \
  https://api.cdq.com/data-exchange/rest/v4/storages/72d6900fce6b326088f5d9d91049e3e6/relations \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
limitinteger(Limit)

Number of items per page.

Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(BusinessPartnerRelation)

List of relations between Business Partners.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "total": "67",
  "values": [
    { … }
  ]
}

Upsert Business Partner Relations

Request

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.

Security
apiKey
Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Bodyapplication/jsonrequired

Parameters for Relations Upsert Request.

relationsArray of objects(BusinessPartnerRelation)[ 1 .. 1000 ] itemsrequired

Batch of Business Partner relations.

relations[].​startedAtstring(BusinessPartnerRelationStartedAt)

Describe when this relationship was first established.

Example: "2025-08-19T06:23:16Z"
relations[].​endedAtstring(BusinessPartnerRelationEndedAt)

Describe when this relationship ended.

Example: "2025-08-19T06:23:16Z"
relations[].​typeobject(BusinessPartnerRelationType)

Provides information about the type of the relationship between two Business Partners like:\ direct parent/child, ultimate parent, branch.

relations[].​classobject(BusinessPartnerRelationClass)

Provides information about the classification of the relation.

relations[].​startNodeobject(BusinessPartnerRelationNode)

Unique identifiers for Business Partner in the relation

relations[].​endNodeobject(BusinessPartnerRelationNode)

Unique identifiers for Business Partner in the relation

relations[].​deactivatedAtstring(BusinessPartnerRelationDeactivatedAt)

Describe when this relationship was deactivated. Read only.

Example: "2025-08-19T06:23:16Z"
curl -i -X PUT \
  https://api.cdq.com/data-exchange/rest/v4/storages/72d6900fce6b326088f5d9d91049e3e6/relations \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "relations": [
      {
        "startedAt": "2025-08-19T06:23:16Z",
        "endedAt": "2025-08-19T06:23:16Z",
        "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": "2025-08-19T06:23:16Z"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
numberOfProvidedRelationsinteger

Number of provided Business Partner Relations.

Example: "10"
numberOfInsertsinteger

Number of inserted Business Partners.

Example: "10"
numberOfUpdatesinteger

Number of updated Business Partners.

Example: "10"
numberOfFailedinteger

Number of failed inserts.

Example: "10"
failuresArray of objects(RelationUpsertFailureLog)

List of relations failed to be inserted or updated.

Response
application/json
{
  "numberOfProvidedRelations": "10",
  "numberOfInserts": "10",
  "numberOfUpdates": "10",
  "numberOfFailed": "10",
  "failures": [
    { … }
  ]
}

Delete relations

Request

Delete relations from a storage.

Security
apiKey
Path
storageIdstring(BusinessPartnerStorageId)required

Unique identifier of the Storage.

Example: 72d6900fce6b326088f5d9d91049e3e6
Bodyapplication/jsonrequired
relationsArray of objects(BusinessPartnerRelationDelete)

List of relations to delete.

curl -i -X POST \
  https://api.cdq.com/data-exchange/rest/v4/storages/72d6900fce6b326088f5d9d91049e3e6/relations/delete \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "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"
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json
deletedinteger

Number of deleted relations.

Example: "10"
Response
application/json
{
  "deleted": "10"
}

Subscriptions

Operations