Batch Lookup

Poll DNB Lookup Job WSDL

SecurityapiKey
Request
path Parameters
id
required
string

id of the DNB lookup job

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/dnb/lookupjobs/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "storageId": "string",
  • "status": "UNKNOWN",
  • "createdAt": "string",
  • "createdBy": "string",
  • "progress": 0,
  • "result": {
    },
  • "modifiedAt": "string",
  • "statusMessage": "string"
}
Poll Lookup Job
SecurityapiKey 
Request 
path Parameters
id
required
string
id of the lookup job


 
Responses 
200
OK


401
Unauthorized


403
Forbidden


404
Not Found


get/lookupjobs/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "storageId": "string",
  • "status": "UNKNOWN",
  • "createdAt": "string",
  • "user": "string",
  • "progress": 0
}
Read DNB Lookup Job results WSDL 
SecurityapiKey 
Request 
path Parameters
id
required
string
id of the lookup job


 
query Parameters
businessPartnerId
Array of strings
Business Partner IDs which should be filtered.


 
limit
integer <int32>   [ 1 .. 100 ] 
 Default:  100
Number of results that should be fetched. Maximum 100 results can be returned in one page.


 
startAfter
string
 Default:  "0"
Only records with an ID greater than this ID will be fetched.


 
Responses 
200
OK


404
Not Found


get/dnb/lookupjobs/{id}/results
Request samples 
Response samples 
application/json
{
  • "startAfter": "string",
  • "nextStartAfter": "string",
  • "limit": 0,
  • "total": 0,
  • "values": [
    ]
}
Start DNB Lookup Job WSDL 
SecurityapiKey 
Request 
Request Body schema: application/json
required
cmd


dnbPassword
string
Optional if credentials are available in user or organization settings


 
dnbUser
string
Optional if credentials are available in user or organization settings


 
featuresOff
Array of strings (DnbLookupJobFeature) 
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.


 
featuresOn
Array of strings (DnbLookupJobFeature) 
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.


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


 Enum: "EXTENDED_MATCH" "MATCH"  
storageId
string
The storage id for which the DNB batch lookup should be done.


 
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": "string",
  • "dnbUser": "string",
  • "dnbPassword": "string",
  • "mode": "EXTENDED_MATCH",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ]
}
Response samples 
application/json
{
  • "id": "string",
  • "storageId": "string",
  • "status": "UNKNOWN",
  • "createdAt": "string",
  • "createdBy": "string",
  • "progress": 0,
  • "result": {
    },
  • "modifiedAt": "string",
  • "statusMessage": "string"
}
Start DNB Report Lookup Job WSDL 
SecurityapiKey 
Request 
path Parameters
id
required
string
id of the DNB report lookup job


 
Responses 
200
OK


get/dnb/lookupreportjobs/{id}
Request samples 
Response samples 
application/json
{
  • "id": "string",
  • "batchLookupJobId": "string",
  • "storageId": "string",
  • "progress": 0,
  • "status": "UNKNOWN",
  • "optionCountriesFilter": [
    ],
  • "attachments": [
    ]
}
Start DNB Report Lookup Job WSDL 
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
 
cdqBatchLookupJobId
string
 
optionCountriesFilter
Array of strings
 
storageId
required
string
 
Responses 
200
OK


400
The sent request is malformed.


post/dnb/lookupreportjobs
Request samples 
application/json
{
  • "batchLookupJobId": "string",
  • "cdqBatchLookupJobId": "string",
  • "storageId": "string",
  • "optionCountriesFilter": [
    ]
}
Response samples 
application/json
{
  • "id": "string",
  • "batchLookupJobId": "string",
  • "storageId": "string",
  • "progress": 0,
  • "status": "UNKNOWN",
  • "optionCountriesFilter": [
    ],
  • "attachments": [
    ]
}
Start Lookup Job
SecurityapiKey 
Request 
Request Body schema: application/json
required
cmd


configurationId
string
Configuration Id used to set up lookup. If provided, those parameters will be affected.
If any of them is provided in this request, will overwrite one from configuration (except for features which are merged):


    

  • dataSource
    • 

  • dataMatchingDefinitionId
    • 

  • matchingThreshold
    • 

  • maxCandidates
    • 

  • pageSize
    • 

  • featuresOn
    • 

  • featuresOff
    • 



 
countryShortNames
Array of strings
If set, only the records that belong to the countries identified by these short names are processed. By default all records of the storage (means from all countries) are processed (considering other filters).


 
dataSourceIds
Array of strings
If set, only the records that belong to the data sources identified by these IDs are processed. By default all records of the storage (means from all data sources) are processed (considering other filters).


 
featuresOff
Array of strings
The features switched off in the lookup


 
featuresOn
Array of strings
The features with which the lookup should be called


 
optionBatchLookupJobId
string
Provide the id of batch lookup job which produced the matches. Providing this option make sens with optionSkipLookup set to true


 
optionCandidates
integer
 Default:  20
Define number of candidates taken into consideration in the matching process


 
optionDataMatchingDefinitionId
string
Provide the id of the data matching definition id. When id worngly set then no matching score will be provided.


 
optionDelay
integer
Add a delay between next lookup calls in miliseconds. example 3000 = 3s


 
optionMatchingConfiguration
string
 Default:  "DEFAULT"
Provide the name of the matching configuration


 
optionMatchingThreshold
string
The matching threshold. When not set then all entries are taken into consideration


 
optionReportMatchingThreshold
string
The matching threshold used to filter out results in report.


 
optionReportName
string
The report name. If a report with that name exists in S3 it will be overwritten. If report name is empty the report name will be the storage id.


 
optionShowAll
boolean
 Default:  0
Display also entries without matches


 
optionSkipExcelReport
boolean
 Deprecated 
 Default:  0
To generate report use POST /referencedatareports


 
optionSkipLookup
boolean
 Default:  0
Skip Lookup


 
optionUseQueues
boolean
 Default:  0
Use workers to do the lookup


 
storageId
string
The storage id for which the batch lookup should be done


 
Array of objects
This field allows to filter data mirrors that will be queried. For each data mirror, data sources can also be filtered. Leave empty to include all available data mirrors in query.


 
Responses 
200
OK


201
Created


400
The sent request is malformed.


401
Unauthorized


403
Forbidden


404
Not Found


post/lookupjobs
Request samples 
application/json
{
  • "storageId": "string",
  • "optionReportName": "string",
  • "optionSkipLookup": true,
  • "optionBatchLookupJobId": "string",
  • "optionSkipExcelReport": true,
  • "optionShowAll": true,
  • "optionUseQueues": true,
  • "optionMatchingThreshold": "string",
  • "optionReportMatchingThreshold": "string",
  • "optionCandidates": 20,
  • "optionMatchingConfiguration": "DEFAULT",
  • "optionDataMatchingDefinitionId": "string",
  • "optionDelay": 3000,
  • "dataSourceIds": [
    ],
  • "countryShortNames": [
    ],
  • "configurationId": "string",
  • "storagesDataSources": [
    ],
  • "featuresOn": [
    ],
  • "featuresOff": [
    ]
}
Response samples 
application/json
{
  • "id": "string",
  • "storageId": "string",
  • "status": "UNKNOWN",
  • "createdAt": "string",
  • "user": "string",
  • "progress": 0
}