Skip to content

Data Exchange API (5)

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

Overview
URL

https://www.cdq.ch/team

Michal Malinka

michal.malinka@cdq.ch

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/

Production SOAP

https://api.corporate-data-league.ch/data-exchange/soap/v5/

Production

https://api.corporate-data-league.ch/data-exchange/

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.

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

Upsert Commercial Ultimates

Request

Upsert Commercial Ultimate for D&B Record to one of your D&B storages in synchronous mode. Every D&B data product is managed in a dedicated storage. Change data products by providing the respective feature.

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/jsonrequired
featuresOnArray of strings(DnbStorageFeatureParam)= 1 itemsrequired

Features to be used during upsert of CommercialUltimates.

Items Enum ValueDescription
SHOW_CDQ_RECORD

Provides CDQ record.

SHOW_FORMATTED_SAP_RECORD

Provides formatted SAP record.

USE_DNB

Create/Use Business Partner Storage for D&B data product Company Profile, Linkage, and Executives (CMPELK)

USE_DNB_MASTER_DATA_BASIC

Create/Use for D&B data product Master Data Basic

USE_DNB_MASTER_DATA_MGMT

Create/Use for D&B data product Master Data Management

USE_DNB_MASTER_DATA_LNKG

Create/Use for D&B data product Master Data Linkage

USE_DNB_MASTER_DATA_EXTENDED

Create/Use for D&B data product Master Data Extended

USE_DNB_LINKAGE_LNKELI

Create/Use for D&B data product Extended Linkage Insight

Example: ["USE_DNB"]
commercialUltimatesArray of objects(CommercialUltimateUpdate)required

List of Global Commercial Ultimate updates.

commercialUltimates[].​dunsstring(Duns)required

DUNS number of the record to be fetched.

Example: "15-048-3782"
commercialUltimates[].​commercialUltimateobject(CommercialUltimate)required

Details of the highest commercial organization in the corporate family hierarchy.

commercialUltimates[].​commercialUltimate.​dunsstring(Duns)

DUNS number of the record to be fetched.

Example: "15-048-3782"
commercialUltimates[].​commercialUltimate.​primaryNamestring

Name of the Commercial Ultimate.

Example: "Dun & Bradstreet, Inc."
commercialUltimates[].​commercialUltimate.​primaryAddressobject(DnBAddress)

The details of the single primary or physical address at which the entity is located.

commercialUltimates[].​commercialUltimate.​pathArray of objects

List of DUNS numbers that represent the path from the subject to the Commercial Ultimate.

domesticCommercialUltimatesArray of objects(CommercialUltimateUpdate)

List of Domestic Commercial Ultimate updates.

curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/dnbstorages/dnbrecords/commercialultimates \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "featuresOn": [
      "USE_DNB"
    ],
    "commercialUltimates": [
      {
        "duns": "15-048-3782",
        "commercialUltimate": {
          "duns": "15-048-3782",
          "primaryName": "Dun & Bradstreet, Inc.",
          "primaryAddress": {
            "language": {
              "description": "English",
              "dnbCode": "39"
            },
            "addressCountry": {
              "name": "United States",
              "isoAlpha2Code": "US",
              "fipsCode": "US"
            },
            "continentalRegion": {
              "name": "North America"
            },
            "addressLocality": {
              "name": "SAN FRANCISCO"
            },
            "minorTownName": "Booker",
            "addressRegion": {
              "name": "Booker",
              "abbreviatedName": "CA",
              "fipsCode": "06"
            },
            "addressCounty": {
              "name": "SAN MATEO",
              "fipsCode": "81"
            },
            "postalCode": "941109999",
            "postalCodePosition": {
              "description": "Post code presented before Town/City name.",
              "dnbCode": "1009"
            },
            "streetNumber": "492",
            "streetName": "KOLLER ST",
            "streetAddress": {
              "line1": "492 KOLLER ST",
              "line2": "Suite 100"
            },
            "postOfficeBox": {
              "postOfficeBoxNumber": "5309",
              "typeDescription": "Supplied by public Post Office authority.",
              "typeDnBCode": "120"
            },
            "latitude": "37.777709",
            "longitude": "-122.404624",
            "geographicalPrecision": {
              "description": "Street Segment Centroid",
              "dnbCode": "30256"
            },
            "isRegisteredAddress": "true",
            "isResidentialAddress": "false",
            "statisticalArea": {
              "cbsaName": "San Francisco-Oakland-Hayward CA",
              "cbsaCode": "41860",
              "economicAreaOfInfluenceCode": "146",
              "populationRank": {
                "rankNumber": "9",
                "rankDnBCode": "10961",
                "rankDescription": "500,000 +"
              }
            },
            "locationOwnership": {
              "description": "Rents",
              "dnbCode": "1129"
            },
            "premisesArea": {
              "measurement": "10034",
              "unitDescription": "square foot",
              "unitDnBCode": "3848",
              "reliabilityDescription": "Actual",
              "reliabilityDnBCode": "9092"
            },
            "isManufacturingLocation": "true"
          },
          "path": [
            {
              "duns": "15-048-3782",
              "primaryName": "Dun & Bradstreet, Inc.",
              "parentDuns": "15-048-3782"
            }
          ]
        }
      }
    ],
    "domesticCommercialUltimates": [
      {
        "duns": "15-048-3782",
        "commercialUltimate": {
          "duns": "15-048-3782",
          "primaryName": "Dun & Bradstreet, Inc.",
          "primaryAddress": {
            "language": {
              "description": "English",
              "dnbCode": "39"
            },
            "addressCountry": {
              "name": "United States",
              "isoAlpha2Code": "US",
              "fipsCode": "US"
            },
            "continentalRegion": {
              "name": "North America"
            },
            "addressLocality": {
              "name": "SAN FRANCISCO"
            },
            "minorTownName": "Booker",
            "addressRegion": {
              "name": "Booker",
              "abbreviatedName": "CA",
              "fipsCode": "06"
            },
            "addressCounty": {
              "name": "SAN MATEO",
              "fipsCode": "81"
            },
            "postalCode": "941109999",
            "postalCodePosition": {
              "description": "Post code presented before Town/City name.",
              "dnbCode": "1009"
            },
            "streetNumber": "492",
            "streetName": "KOLLER ST",
            "streetAddress": {
              "line1": "492 KOLLER ST",
              "line2": "Suite 100"
            },
            "postOfficeBox": {
              "postOfficeBoxNumber": "5309",
              "typeDescription": "Supplied by public Post Office authority.",
              "typeDnBCode": "120"
            },
            "latitude": "37.777709",
            "longitude": "-122.404624",
            "geographicalPrecision": {
              "description": "Street Segment Centroid",
              "dnbCode": "30256"
            },
            "isRegisteredAddress": "true",
            "isResidentialAddress": "false",
            "statisticalArea": {
              "cbsaName": "San Francisco-Oakland-Hayward CA",
              "cbsaCode": "41860",
              "economicAreaOfInfluenceCode": "146",
              "populationRank": {
                "rankNumber": "9",
                "rankDnBCode": "10961",
                "rankDescription": "500,000 +"
              }
            },
            "locationOwnership": {
              "description": "Rents",
              "dnbCode": "1129"
            },
            "premisesArea": {
              "measurement": "10034",
              "unitDescription": "square foot",
              "unitDnBCode": "3848",
              "reliabilityDescription": "Actual",
              "reliabilityDnBCode": "9092"
            },
            "isManufacturingLocation": "true"
          },
          "path": [
            {
              "duns": "15-048-3782",
              "primaryName": "Dun & Bradstreet, Inc.",
              "parentDuns": "15-048-3782"
            }
          ]
        }
      }
    ]
  }'

Responses

OK

Bodyapplication/json
numberOfProvidedinteger(int32)

Represents number of Commercial ultimates to update provided in CommercialUltimateUpsertRequest.

Example: "100"
numberOfUpdatedinteger(int32)

Represents number of updated Commercial ultimates.

Example: "100"
numberOfFailedinteger(int32)

Number of failed updates.

Example: "50"
failuresArray of objects(DnbRecordFailureLog)

List of failed updates.

Response
application/json
{
  "numberOfProvided": "100",
  "numberOfUpdated": "100",
  "numberOfFailed": "50",
  "failures": [
    { … }
  ]
}

Create or Retrieve DNB Storage

Request

Create or retrieve if exists D&B storage and add to organization settings

Security
basicAuth
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/json
featuresOnArray of strings(DnbStorageFeatureParam)

List of features to be activated.

Items Enum ValueDescription
SHOW_CDQ_RECORD

Provides CDQ record.

SHOW_FORMATTED_SAP_RECORD

Provides formatted SAP record.

USE_DNB

Create/Use Business Partner Storage for D&B data product Company Profile, Linkage, and Executives (CMPELK)

USE_DNB_MASTER_DATA_BASIC

Create/Use for D&B data product Master Data Basic

USE_DNB_MASTER_DATA_MGMT

Create/Use for D&B data product Master Data Management

USE_DNB_MASTER_DATA_LNKG

Create/Use for D&B data product Master Data Linkage

USE_DNB_MASTER_DATA_EXTENDED

Create/Use for D&B data product Master Data Extended

USE_DNB_LINKAGE_LNKELI

Create/Use for D&B data product Extended Linkage Insight

Example: ["USE_DNB"]
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/dnbstorages \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "featuresOn": [
      "USE_DNB"
    ]
  }'

Responses

OK

Bodyapplication/json
idstring

Unique ID of the D&B storage.

Example: "ff864c7bfe38397b8c160bc624f97574"
technicalKeystring(DnbStorageTechnicalKey)

Technical key that describes what kind if D&B storage it is.

Example: "DNB_MASTER_DATA_BASIC"
numberOfRecordsinteger

Number of records stored in D&B storage.

Example: 101
Response
application/json
{
  "id": "ff864c7bfe38397b8c160bc624f97574",
  "technicalKey": "DNB_MASTER_DATA_BASIC",
  "numberOfRecords": 101
}

List DNB storages

Request

Read a page of existing D&B storage that optionally is filtered by a technicalKey.

Security
basicAuth
Query
pageinteger(int32)>= 0

Number of the page that will be retrieved.

Default 0
Example: page=10
pageSizeinteger(int32)>= 1

Number of items to be returned on the page.

Default 20
Example: pageSize=10
technicalKeystring(DnbStorageTechnicalKeyParam)

D&B Storage type to filter by.

Enum ValueDescription
DNB

Storage for D&B data product Company Profile, Linkage, and Executives (CMPELK)

DNB_MASTER_DATA_BASIC

Storage for D&B data product Master Data Basic

DNB_MASTER_DATA_MGMT

Storage for D&B data product Master Data Mgmt

DNB_MASTER_DATA_LNKG

Storage for D&B data product Master Data Lnkg

DNB_MASTER_DATA_EXTENDED

Storage for D&B data product Master Data Extended

DNB_LINKAGE_LNKELI

Storage for D&B data product Extended Linkage Insight

Example: technicalKey=DNB_MASTER_DATA_BASIC
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/dnbstorages \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(DnbStorageResult)

List of D&B Storages.

Example: "[ { \"id\":\"ff864c7bfe38397b8c160bc624f97574, \"technicalKey\":\"DNB_MASTER_DATA_BASIC\"} ]"
Response
application/json
{
  "page": "1",
  "pageSize": "100",
  "total": "67",
  "values": "[ { \"id\":\"ff864c7bfe38397b8c160bc624f97574, \"technicalKey\":\"DNB_MASTER_DATA_BASIC\"} ]"
}

Files

Provides functionalities for uploading, downloading and deleting files.

Operations

Subscriptions

Provides functionalities for managing subscriptions.

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

Update Classification

Operations

Event Stores

Operations

Business Partner Storages (None Public)

Operations

Restart Monitor Job

Operations

Cache

Operations

Configuration

Operations

Event Store

Operations

CDQ Community Pool

Operations