SAP ODM API (3)

Download OpenAPI specification:Download

This API provides access to several CDQ API endpoints according to the SAP One Domain Model (ODM). Requests and responses are mapped from the CDQ data model to ODM in order to simplify service access from SAP systems.

Bulk Fetch

Bulk Fetch

Create Bulk Fetch

Create a bulk to fetch multiple business partners at a time

SecurityapiKey
Request
Request Body schema: application/json
required
configurationId
string

Configuration ID used to set up fetch. 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):

  • screeningMatchingThreshold
  • featuresOn
  • featuresOff
Example: "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4"
featuresOff
Array of strings

List of features to be deactivated.

Items Enum: Description
ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_RAW_DATA

Show raw data returned by external service.

SHOW_RAW_DATA_JSON

Show raw data returned by external service in JSON format.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

SCREEN_BUSINESS_NAMES

Add screeningResult to the Business Partner.

SHOW_COMMERCIAL_ULTIMATE

Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

SHOW_DOMESTIC_COMMERCIAL_ULTIMATE

BETA
Fetch Domestic Commercial Ultimate from DNB. ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

DETECT_LEGAL_ENTITY

BETA
Finds out whether requested DUNS is a branch or headquarter.

ACTIVATE_DATASOURCE_BVD

Allows to use DVB datasource in golden record.

ACTIVATE_DATASOURCE_DNB

Allows to use DNB datasource in golden record.

ACTIVATE_MASTER_DATA_BASIC

Use basic set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_EXTENDED

Use extended set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_MGMT

Use mgmt set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_LNKG

Use lnkg set of datablocks to fetch data.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

USE_FETCH_STRATEGY_GOLDEN_RECORD

Use golden record fetch strategy.

Example: ["SHOW_RAW_DATA"]
featuresOn
Array of strings

List of features to be activated.

Items Enum: Description
ENABLE_SETTINGS

Apply rules stored in organizational settings during curation.

SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, request, request after curation procedure and responses from external services.

SHOW_RAW_DATA

Show raw data returned by external service.

SHOW_RAW_DATA_JSON

Show raw data returned by external service in JSON format.

FORCE_EXTERNAL_CALL

Call external service even when results from data mirrors are available.

SCREEN_BUSINESS_NAMES

Add screeningResult to the Business Partner.

SHOW_COMMERCIAL_ULTIMATE

Fetch Global Commercial Ultimate from BvD or DNB (depending on selected datasource). ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

SHOW_DOMESTIC_COMMERCIAL_ULTIMATE

BETA
Fetch Domestic Commercial Ultimate from DNB. ACTIVATE_DATASOURCE_DNB, ACTIVATE_MASTER_DATA_EXTENDED or ACTIVATE_MASTER_DATA_LNKG must be active if you want to calculate DNB commercial ultimate.

DETECT_LEGAL_ENTITY

BETA
Finds out whether requested DUNS is a branch or headquarter.

ACTIVATE_DATASOURCE_BVD

Allows to use DVB datasource in golden record.

ACTIVATE_DATASOURCE_DNB

Allows to use DNB datasource in golden record.

ACTIVATE_MASTER_DATA_BASIC

Use basic set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_EXTENDED

Use extended set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_MGMT

Use mgmt set of datablocks to fetch data.

ACTIVATE_MASTER_DATA_LNKG

Use lnkg set of datablocks to fetch data.

ACTIVATE_LINKAGE_LNKELI

Fetch LNKELI data.

USE_FETCH_STRATEGY_GOLDEN_RECORD

Use golden record fetch strategy.

Example: ["SHOW_RAW_DATA"]
screeningMatchingThreshold
number

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

Example: "0.8"
required
Array of objects [ 1 .. 1000 ] items

List of tasks to be executed.

Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/referencedata/rest/v4/businesspartners/fetch/bulks
Request samples
application/json
{
  • "featuresOn": [
    ],
  • "tasks": [
    ]
}
Response samples
application/json
{
  • "id": "650b12ac-3768-11ee-be56-0242ac120002",
  • "createdAt": "2024-06-20T07:02:42Z",
  • "finishedAt": "2024-06-20T07:02:42Z",
  • "createdBy": "76248934691294444",
  • "status": {
    },
  • "progress": "77",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ],
  • "screeningMatchingThreshold": "0.8",
  • "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "results": [
    ],
  • "nextStartAfter": "5712566172571652"
}

Read Bulk Fetch

Read results for fetch bulk

SecurityapiKey
Request
path Parameters
id
required
string

Unique identifier for a bulk.

Example: cbed7ac6-a97d-4c23-9060-2a88fa660957
query Parameters
limit
integer <int32> [ 1 .. 1000 ]
Default: 100

Number of items to be returned on the page.

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

Pagination cursor which should be filled with nextStartAfter value provided in the previous page read response.

Example: startAfter=16
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/referencedata/rest/v4/businesspartners/fetch/bulks/{id}
Request samples
Response samples
application/json
{
  • "id": "650b12ac-3768-11ee-be56-0242ac120002",
  • "createdAt": "2024-06-20T07:02:42Z",
  • "finishedAt": "2024-06-20T07:02:42Z",
  • "createdBy": "76248934691294444",
  • "status": {
    },
  • "progress": "77",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ],
  • "screeningMatchingThreshold": "0.8",
  • "configurationId": "c074b9f3-abf0-4f8e-9a20-74deb6cfa2a4",
  • "results": [