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
featuresOff
Array of strings

The features switched off in the business partner fetch

Items Enum: "ENABLE_SETTINGS" "SHOW_DEBUG_INFO" "SHOW_RAW_DATA" "SHOW_RAW_DATA_JSON" "FORCE_EXTERNAL_CALL" "SCREEN_BUSINESS_NAMES" "SHOW_COMMERCIAL_ULTIMATE" "ACTIVATE_DATASOURCE_BVD" "ACTIVATE_DATASOURCE_DNB" "ACTIVATE_MASTER_DATA_BASIC" "ACTIVATE_MASTER_DATA_EXTENDED" "ACTIVATE_LINKAGE_LNKELI" "USE_FETCH_STRATEGY_GOLDEN_RECORD"
featuresOn
Array of strings

The features with which the business partner fetch should be called

Items Enum: "ENABLE_SETTINGS" "SHOW_DEBUG_INFO" "SHOW_RAW_DATA" "SHOW_RAW_DATA_JSON" "FORCE_EXTERNAL_CALL" "SCREEN_BUSINESS_NAMES" "SHOW_COMMERCIAL_ULTIMATE" "ACTIVATE_DATASOURCE_BVD" "ACTIVATE_DATASOURCE_DNB" "ACTIVATE_MASTER_DATA_BASIC" "ACTIVATE_MASTER_DATA_EXTENDED" "ACTIVATE_LINKAGE_LNKELI" "USE_FETCH_STRATEGY_GOLDEN_RECORD"
screeningMatchingThreshold
number

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

required
Array of objects [ 1 .. 1000 ] items
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

post/referencedata/rest/v4/businesspartners/fetch/bulks
Request samples
application/json
{
  • "featuresOn": [
    ],
  • "featuresOff": [
    ],
  • "screeningMatchingThreshold": 0,
  • "configurationId": "string",
  • "tasks": [
    ]
}
Response samples
application/json
{
  • "id": "650b12ac-3768-11ee-be56-0242ac120002",
  • "createdAt": "2020-08-31T16:47+00:00",
  • "finishedAt": "2020-08-31T16:47+00:00",
  • "createdBy": "76248934691294444",
  • "status": {
    },
  • "progress": "77",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ],
  • "screeningMatchingThreshold": 0,
  • "configurationId": "string",
  • "results": [
    ]
}

Read Bulk Fetch

Read results for fetch bulk

SecurityapiKey
Request
path Parameters
id
required
string

Unique identifier for a bulk

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": "2020-08-31T16:47+00:00",
  • "finishedAt": "2020-08-31T16:47+00:00",
  • "createdBy": "76248934691294444",
  • "status": {
    },
  • "progress": "77",
  • "featuresOn": [
    ],
  • "featuresOff": [
    ],
  • "screeningMatchingThreshold": 0,
  • "configurationId": "string",
  • "results": [
    ]
}