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

List DNB Records

Request

Read a page of records from the D&B storage of your organization.

Security
basicAuth
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
featuresOnArray of strings(DnbRecordsReadFeatureParam)

Features to be activated during the D&B Records read.

Items Enum ValueDescription
NUMBER_OF_TOTAL

Provides total number of records in the storage.

SHOW_CDQ_RECORD

Provides CDQ record.

USE_DNB_MASTER_DATA_BASIC

Uses D&B Master Data Basic.

USE_DNB_MASTER_DATA_MGMT

Uses D&B Master Data Mgmt.

USE_DNB_MASTER_DATA_LNKG

Uses D&B Master Data Lnkg.

USE_DNB_MASTER_DATA_EXTENDED

Uses D&B Master Data Extended.

USE_DNB_LINKAGE_LNKELI

Uses D&B Linkage LNKELI.

Example: featuresOn=SHOW_CDQ_RECORD
featuresOffArray of strings(DnbRecordsReadFeatureParam)

Features to be deactivated during the D&B Records read.

Items Enum ValueDescription
NUMBER_OF_TOTAL

Provides total number of records in the storage.

SHOW_CDQ_RECORD

Provides CDQ record.

USE_DNB_MASTER_DATA_BASIC

Uses D&B Master Data Basic.

USE_DNB_MASTER_DATA_MGMT

Uses D&B Master Data Mgmt.

USE_DNB_MASTER_DATA_LNKG

Uses D&B Master Data Lnkg.

USE_DNB_MASTER_DATA_EXTENDED

Uses D&B Master Data Extended.

USE_DNB_LINKAGE_LNKELI

Uses D&B Linkage LNKELI.

Example: featuresOff=SHOW_CDQ_RECORD
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/public/v5/dnbstorages/dnbrecords

Responses

OK

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

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(DnbRecord)

List of D&B Records.

nextStartAfterstring(NextStartAfter)

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

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

Read DNB Records

Request

Read a page of records from the D&B storage of your organization.

Security
basicAuth
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
featuresOnArray of strings(DnbRecordsReadFeatureParam)

Features to be activated during the D&B Records read.

Items Enum ValueDescription
NUMBER_OF_TOTAL

Provides total number of records in the storage.

SHOW_CDQ_RECORD

Provides CDQ record.

USE_DNB_MASTER_DATA_BASIC

Uses D&B Master Data Basic.

USE_DNB_MASTER_DATA_MGMT

Uses D&B Master Data Mgmt.

USE_DNB_MASTER_DATA_LNKG

Uses D&B Master Data Lnkg.

USE_DNB_MASTER_DATA_EXTENDED

Uses D&B Master Data Extended.

USE_DNB_LINKAGE_LNKELI

Uses D&B Linkage LNKELI.

Example: featuresOn=SHOW_CDQ_RECORD
featuresOffArray of strings(DnbRecordsReadFeatureParam)

Features to be deactivated during the D&B Records read.

Items Enum ValueDescription
NUMBER_OF_TOTAL

Provides total number of records in the storage.

SHOW_CDQ_RECORD

Provides CDQ record.

USE_DNB_MASTER_DATA_BASIC

Uses D&B Master Data Basic.

USE_DNB_MASTER_DATA_MGMT

Uses D&B Master Data Mgmt.

USE_DNB_MASTER_DATA_LNKG

Uses D&B Master Data Lnkg.

USE_DNB_MASTER_DATA_EXTENDED

Uses D&B Master Data Extended.

USE_DNB_LINKAGE_LNKELI

Uses D&B Linkage LNKELI.

Example: featuresOff=SHOW_CDQ_RECORD
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/v5/dnbstorages/dnbrecords

Responses

OK

Bodyapplication/json
startAfterstring(StartAfter)

The ID which is used to read the page.

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(DnbRecord)

List of D&B Records.

nextStartAfterstring(NextStartAfter)

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

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

Start DNB Import Job

Request

To start a DNB Import Job use the following request

curl -X POST \
  --url 'https://api.corporate-data-league.ch/data-exchange/rest/jobs/dnbimportjobs?dnbUser=optional&dnbPassword=optional' \
  -u 'BasicAuthUserName:your_credentials'\
  -H 'Accept: application/json' \
  -F 'file=@your_file.csv'

with using this sample file:

DUNS
305211311
DNB:305211311

The file can be a csv or xlsx. The file should contain only one column with the DUNS number. In the first row should the header DUNS. The DUNS number can be in following forms:

  • As CDQ-ID. Example DNB:305211311
  • as raw DUNS 305211311

The DUNS consist of 9 digits. When the input DUNS does not consist of 9 digits, leading zeros are added.

Security
basicAuth
Query
namestring(JobName)

Name of the job.

Example: name=Process vendor data.
descriptionstring(JobDescription)

Description of the job.

Example: description=I started this job to improve quality of our data.
dnbUserstring

Optional, if credentials are available in user or organization settings.

Example: dnbUser=your_dnb_user
dnbPasswordstring

Optional, if credentials are available in user or organization settings.

Example: dnbPassword=your_dnb_password
featuresOnArray of strings(DnbImportJobFeature)

Features to be activated.

Items Enum ValueDescription
ENRICH_COMMERCIAL_ULTIMATE

Enriches Commercial Ultimate.

ENABLE_PARTIAL_QUOTA_CONSUMPTION

Enables to run import job on a remaining quota when full quota not available.

SKIP_DNB_IMPORT

Skips requesting D&B data from D&B services. Can be used to enrich only Commercial Ultimate.

INCREMENT

Continue processing after the last processed result with a goal to run on newly created Business Partners from a Business Partner Storage.

ACTIVATE_MASTER_DATA_EXTENDED

Enables to use data blocks instead of cmplek when fetching data from DNB.

Example: featuresOn=ENRICH_COMMERCIAL_ULTIMATE
dnbDataSourcestring(DnbStorageTechnicalKeyParam)

D&B product that should be downloaded from D&B and put into specific D&B storage.

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: dnbDataSource=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
Bodymultipart/form-data
filestring(binary)

XLSX or CSV file to be uploaded, containing mandatory DUNS column (SOAP currently only supports CSV).

Example: "CH-import.csv"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-exchange-api/api-v5/jobs/dnbimportjobs \
  -H 'Content-Type: multipart/form-data' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -F file=CH-import.csv

Responses

OK

Bodyapplication/json
idstring(JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
namestring(JobName)

Name of a Job.

Example: "Process vendor data."
descriptionstring(JobDescription)

Detailed description of a Job.

Example: "I started this job to improve quality of our data."
progressinteger(JobProgress)[ 0 .. 100 ]

Progress (%) of the job.

Example: "77"
statusstring(JobStatus)

Job execution status.

Enum ValueDescription
ARCHIVED

Job has been archived.

UNKNOWN

Job becomes in unknown status.

CREATED

Job has been created.

PERSISTED

Job metadata has been persisted.

SCHEDULED

Job has been scheduled for execution.

WAITING

Job is waiting for being scheduled.

COULDNT_START

Job could not be started.

RUNNING

Job is being executed.

FINISHED

Job has finished.

DIED

Job was scheduled and started running but died unexpectedly.

Example: "RUNNING"
statusMessagestring

Message describing the status of the job.

Example: "Job is running"
createdBystring(CreatedBy)

Creator of a resource.

Example: "76248934691294444"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
resultobject(DnbImportJobResult)

Result of D&B import job.

Response
application/json
{
  "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  "name": "Process vendor data.",
  "description": "I started this job to improve quality of our data.",
  "progress": "77",
  "status": "RUNNING",
  "statusMessage": "Job is running",
  "createdBy": "76248934691294444",
  "createdAt": "2020-08-31T16:47+00:00",
  "modifiedAt": "2020-08-31T16:47+00:00",
  "result": {
    "statistics": { … }
  }
}

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