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

Poll DNB LOD Job

Request

After you have started a D&B LOD job, you will receive a job id in the response. { "id" : "<ID>" } Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can see the results in the attachments.

Security
basicAuth
Path
idstring(JobId)required

ID of the D&B Create LOD job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
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/public/jobs/dnbcreatelodjobs/35f23c03-1c22-45fe-9484-3ffe769325de \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

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"
attachmentsArray of objects(FileResource)

List of attachments.

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",
  "attachments": [
    { … }
  ]
}

Fetch DNB Record

Request

Fetch a D&B record by providing the DUNS.

Security
basicAuth
Bodyapplication/jsonrequired
dunsstring(Duns)required

DUNS number of the record to be fetched.

Example: "15-048-3782"
featuresOnArray of strings(DnbStorageFeatureParam)

Features to be used during the D&B storage creation.

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/public/v4/dnbstorages/fetch \
  -H 'Content-Type: application/json' \
  -d '{
    "duns": "15-048-3782",
    "featuresOn": [
      "USE_DNB"
    ]
  }'

Responses

OK

Bodyapplication/json
dnbRecordobject(DnbRecord)

D&B Record.

statusstring

status:

  • OK - D&B Record has been fetched successfully.
  • NOT_FOUND - D&B Record with that DUNS does not exist in storage.
Example: "OK"
messagestring

Message describing the status of the request.

Example: "D&B Record has been fetched successfully"
Response
application/json
{
  "dnbRecord": {
    "duns": "15-048-3782",
    "cmpelkV2": { … },
    "dataBlock": { … },
    "cdqRecord": { … },
    "commercialUltimate": { … },
    "domesticCommercialUltimate": { … },
    "modifiedAt": "2020-08-31T16:47+00:00",
    "lastSyncAt": "2020-02-11T00:00:00Z"
  },
  "status": "OK",
  "message": "D&B Record has been fetched successfully"
}

Fetch DNB Record

Request

Fetch a D&B record by providing the DUNS.

Security
basicAuth
Bodyapplication/jsonrequired
dunsstring(Duns)required

DUNS number of the record to be fetched.

Example: "15-048-3782"
featuresOnArray of strings(DnbStorageFeatureParam)

Features to be used during the D&B storage creation.

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/v4/dnbstorages/fetch \
  -H 'Content-Type: application/json' \
  -d '{
    "duns": "15-048-3782",
    "featuresOn": [
      "USE_DNB"
    ]
  }'

Responses

OK

Bodyapplication/json
dnbRecordobject(DnbRecord)

D&B Record.

statusstring

status:

  • OK - D&B Record has been fetched successfully.
  • NOT_FOUND - D&B Record with that DUNS does not exist in storage.
Example: "OK"
messagestring

Message describing the status of the request.

Example: "D&B Record has been fetched successfully"
Response
application/json
{
  "dnbRecord": {
    "duns": "15-048-3782",
    "cmpelkV2": { … },
    "dataBlock": { … },
    "cdqRecord": { … },
    "commercialUltimate": { … },
    "domesticCommercialUltimate": { … },
    "modifiedAt": "2020-08-31T16:47+00:00",
    "lastSyncAt": "2020-02-11T00:00:00Z"
  },
  "status": "OK",
  "message": "D&B Record has been fetched successfully"
}

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