Batch Lookup

Poll DNB Lookup JobWSDL

After you have started a curation job, you will receive a job id in the response: { 'id' : '' } Use this ID to poll for the status of the job using this endpoint. Once the status is FINISHED, you can download the results.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the DNB lookup job.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/dnb/lookupjobs/{id}
Request samples
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "status": "RUNNING",
  • "createdAt": "2024-07-11T07:22:27Z",
  • "createdBy": "76248934691294444",
  • "progress": "77",
  • "result": {
    },
  • "modifiedAt": "2024-07-11T07:22:27Z",
  • "statusMessage": "The job failed because storage is empty."
}

Read DNB Lookup Job resultsWSDL

Reads the results of a DNB lookup job by job ID.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the lookup job.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957
query Parameters
businessPartnerId
Array of strings (BusinessPartnerId)

Business Partner IDs which should be filtered.

Example: businessPartnerId=63e635235c06b7396330fe40
limit
integer <int32> [ 1 .. 100 ]
Default: 100

Number of results that should be fetched. Maximum 100 results can be returned in one page.

Example: limit=50
startAfter
string
Default: "0"

Only records with an ID greater than this ID will be fetched.

Example: startAfter=5712566172571652
Responses
200

OK

404

Not Found

get/dnb/lookupjobs/{id}/results
Request samples
Response samples
application/json
{
  • "startAfter": "5712566172571652",
  • "nextStartAfter": "5712566172571652",
  • "limit": "100",
  • "total": "67",
  • "values": [
    ]
}

Start DNB Lookup JobWSDL

Initialisation of a DNB lookup job. The job will be executed asynchronously. The response contains the job ID which can be used to poll for the status of the job.

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

dnbDataSource
string
Default: "DNB"

D&B name of the product to be used in the job.

Enum: Description
DNB

D&B Master Data

DNB_MASTER_DATA_BASIC

D&B Master Data Basic

DNB_MASTER_DATA_PLUS_MGMT

D&B Master Data Plus Management

DNB_MASTER_DATA_PLUS_LINKAGE

D&B Master Data Plus Linkage

DNB_MASTER_DATA_EXTENDED

D&B Master Data Extended

DNB_LINKAGE_LNKELI

D&B Linkage LNKELI

Example: "DNB_MASTER_DATA_EXTENDED"
dnbPassword
string

Optional if credentials are available in user or organization settings.

Example: "myDnbPassword"
dnbUser
string

Optional if credentials are available in user or organization settings.

Example: "myDnbUser"
featuresOff
Array of strings (DnbLookupJobFeature)

List of features to be deactivated in the lookup.

Items Enum: Description
INCREMENT

Continue processing after the last processed result with a goal to run on newly created business partners from a storage.

ENABLE_PARTIAL_QUOTA_CONSUMPTION

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

ACTIVATE_MASTER_DATA_EXTENDED

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

SKIP_DNB_IMPORT

If it is not used, all DUNS will be fetched from DNB. Should be used in combination with ENRICH_COMMERCIAL_ULTIMATE to only load what is needed for commercial ultimate calculation.

ENRICH_COMMERCIAL_ULTIMATE

Calculate commercial ultimate for each business partner in storage.

Example: ["INCREMENT"]
featuresOn
Array of strings (DnbLookupJobFeature)

List of features to be activated in the lookup.

Items Enum: Description
INCREMENT

Continue processing after the last processed result with a goal to run on newly created business partners from a storage.

ENABLE_PARTIAL_QUOTA_CONSUMPTION

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

ACTIVATE_MASTER_DATA_EXTENDED

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

SKIP_DNB_IMPORT

If it is not used, all DUNS will be fetched from DNB. Should be used in combination with ENRICH_COMMERCIAL_ULTIMATE to only load what is needed for commercial ultimate calculation.

ENRICH_COMMERCIAL_ULTIMATE

Calculate commercial ultimate for each business partner in storage.

Example: ["INCREMENT"]
mode
string

MATCH contains just the match results while EXTENDED_MATCH also includes D&B products (attention increased costs)

Enum: "EXTENDED_MATCH" "MATCH"
Example: "EXTENDED_MATCH"
storageId
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
Responses
200

OK

201

Created

400

The sent request is malformed.

401

Unauthorized

403

Forbidden

404

Not Found

post/dnb/lookupjobs
Request samples
application/json
{
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "dnbUser": "myDnbUser",
  • "dnbPassword": "myDnbPassword",
  • "mode": "EXTENDED_MATCH",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ],
  • "dnbDataSource": "DNB_MASTER_DATA_EXTENDED"
}
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "status": "RUNNING",
  • "createdAt": "2024-07-11T07:22:27Z",
  • "createdBy": "76248934691294444",
  • "progress": "77",
  • "result": {
    },
  • "modifiedAt": "2024-07-11T07:22:27Z",
  • "statusMessage": "The job failed because storage is empty."
}

Start DNB Report Lookup JobWSDL

Generates a DNB report lookup job. The job will be executed asynchronously. The response contains the job ID which can be used to poll for the status of the job.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the DNB report lookup job.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957
Responses
200

OK

get/dnb/lookupreportjobs/{id}
Request samples
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "batchLookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "progress": "77",
  • "status": "RUNNING",
  • "optionCountriesFilter": [
    ],
  • "attachments": [
    ]
}

Start DNB Report Lookup JobWSDL

Endpoint is deprecated. Should not be used anymore. For report generation use POST /public/referencedatareports

SecurityapiKey
Request
Request Body schema: application/json
required

cmd

batchLookupJobId
required
string (JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
cdqBatchLookupJobId
string (JobId)

Unique identifier of a job.

Example: "35f23c03-1c22-45fe-9484-3ffe769325de"
optionCountriesFilter
Array of strings (CountryShortName)

List of countries to filter.

Example: ["CH"]
storageId
required
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
Responses
200

OK

400

The sent request is malformed.

post/dnb/lookupreportjobs
Request samples
application/json
{
  • "batchLookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "cdqBatchLookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "optionCountriesFilter": [
    ]
}
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "batchLookupJobId": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "progress": "77",
  • "status": "RUNNING",
  • "optionCountriesFilter": [
    ],
  • "attachments": [
    ]
}