DNB Storages

Create LOD File

For all data mirrors configured for an organization read Business Partners identifiers with type DUNS_ID and create a List fd DUNS file. This file is used the initialization of the D&B Monitoring process

SecurityapiKey
Request
Request Body schema: application/json
optional
description
string (JobDescription)

Detailed description of a Job.

Example: "I started this job to improve quality of our data."
name
string (JobName)

Name of a Job.

Example: "Process vendor data."
Responses
200

OK

400

The sent request is malformed.

post/jobs/dnbcreatelodjobs
Request samples
application/json
{
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data."
}
Response samples
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": "2024-05-21T11:45:12Z",
  • "modifiedAt": "2024-05-21T11:45:12Z",
  • "attachments": [
    ]
}

Fetch DNB Record

Fetch a D&B record by providing the DUNS.

SecurityapiKey
Request
Request Body schema: application/json
required
duns
required
string (Duns)

DUNS number of the record to be fetched.

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

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

Items Enum: Description
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"]
Responses
200

OK

post/dnbstorages/fetch
Request samples
application/json
{
  • "duns": "15-048-3782",
  • "featuresOn": [
    ]
}
Response samples
application/json
{
  • "dnbRecord": {
    },
  • "status": "OK",
  • "message": "D&B Record has been fetched successfully"
}

Poll DNB Import Job

After you have started a D&B import 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 D&B storage.

SecurityapiKey
Request
path Parameters
id
required
string (JobId)

ID of the D&B import job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
Responses
200

OK

get/jobs/dnbimportjobs/{id}
Request samples
Response samples
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": "2024-05-21T11:45:12Z",
  • "modifiedAt": "2024-05-21T11:45:12Z",
  • "result": {
    }
}

Poll DNB LOD Job

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.

SecurityapiKey
Request
path Parameters
id
required
string (JobId)

ID of the D&B Create LOD job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
Responses
200

OK

get/jobs/dnbcreatelodjobs/{id}
Request samples
Response samples
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": "2024-05-21T11:45:12Z",
  • "modifiedAt": "2024-05-21T11:45:12Z",
  • "attachments": [
    ]
}

Poll DNB Report Job

After you have started a D&B report 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.

SecurityapiKey
Request
path Parameters
id
required
string (JobId)

ID of the D&B report job.

Example: 35f23c03-1c22-45fe-9484-3ffe769325de
Responses
200

OK

get/jobs/dnbreportjobs/{id}
Request samples
Response samples
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": "2024-05-21T11:45:12Z",
  • "modifiedAt": "2024-05-21T11:45:12Z",
  • "attachments": [
    ]
}

Read DNB Records

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

SecurityapiKey
Request
query Parameters
featureOff
Array of strings (DnbRecordsReadFeatureParam)

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

Items Enum: Description
NUMBER_OF_TOTAL

Provides total number of records in the storage.

SHOW_CDQ_RECORD

Provides CDQ record.

SHOW_FORMATTED_SAP_RECORD

Provides formatted SAP 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: featureOff=SHOW_CDQ_RECORD
featureOn
Array of strings (DnbRecordsReadFeatureParam)

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

Items Enum: Description
NUMBER_OF_TOTAL

Provides total number of records in the storage.

SHOW_CDQ_RECORD

Provides CDQ record.

SHOW_FORMATTED_SAP_RECORD

Provides formatted SAP 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: featureOn=SHOW_CDQ_RECORD
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
Responses
200

OK

get/v4/dnbstorages/dnbrecords
Request samples
Response samples
application/json
{
  • "startAfter": "5712566172571652",
  • "limit": "100",
  • "total": "67",
  • "values": [
    ],
  • "nextStartAfter": "5712566172571652"
}

Start DNB Import Job

To start a D&B 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 or 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.

SecurityapiKey
Request
query Parameters
description
string (JobDescription)

Description of the job.

Example: description=I started this job to improve quality of our data.
dnbDataSource
string (DnbStorageTechnicalKeyParam)

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

Enum: Description
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
dnbPassword
string

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

Example: dnbPassword=password
dnbUser
string

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

Example: dnbUser=username
featuresOn
Array of strings (DnbImportJobFeature)

Feature to be activated.

Items Enum: Description
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
name
string (JobName)

Name of the job.

Example: name=Process vendor data.
Request Body schema: multipart/form-data
file
string <binary>

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

Example: "CH-import.csv"
Responses
200

OK

400

The sent request is malformed.

post/jobs/dnbimportjobs
Request samples
Response samples
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": "2024-05-21T11:45:12Z",
  • "modifiedAt": "2024-05-21T11:45:12Z",
  • "result": {
    }
}

Start DNB Report Job

To start a DNB Report Job use the job name and its description.

SecurityapiKey
Request
Request Body schema: application/json
optional
description
string (JobDescription)

Detailed description of a Job.

Example: "I started this job to improve quality of our data."
name
string (JobName)

Name of a Job.

Example: "Process vendor data."
Responses
200

OK

400

The sent request is malformed.

post/jobs/dnbreportjobs
Request samples
application/json
{
  • "name": "Process vendor data.",
  • "description": "I started this job to improve quality of our data."
}
Response samples
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": "2024-05-21T11:45:12Z",
  • "modifiedAt": "2024-05-21T11:45:12Z",
  • "attachments": [
    ]
}