Skip to content

SAP ODM API (2)

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.

Download OpenAPI description
api-v2.json
api-v2.yaml
Languages
Servers
Mock server

https://developer.cdq.com/_mock/apis/sap-odm-api/v2/api-v2/

Production

https://api.cdq.com/sap-odm/v2/

Business Partners

Operations

Lookup Business Partners

Request

Lookup a business partner in all available data sources.

Security
apiKey
Bodyapplication/jsonrequired
businessPartnerobject(BusinessPartner)

An organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.

matchingThresholdnumber(double)[ 0 .. 1 ]

The matching threshold for the lookup.

Example: "0.5"
maxCandidatesinteger[ 20 .. 100 ]

The maximum number of candidates to be returned by the lookup. Default 50.

Example: "50"
pageSizeinteger[ 1 .. 1000 ]

Number of items per page. Default 10.

Example: "100"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
limitinteger[ 0 .. 1000 ]

Number of items per page.

Example: "100"
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
featuresOnArray of strings(LookupBusinessPartnerFeature)

List of features to be activated.

Items Enum ValueDescription
SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, and request.

SHOW_GOLDENRECORD_QUICK

Calculate golden record for given request.

SHOW_GOLDENRECORD_STANDARD

Calculate golden record for given request.

Example: ["SHOW_DEBUG_INFO"]
featuresOffArray of strings(LookupBusinessPartnerFeature)

List of features to be deactivated.

Items Enum ValueDescription
SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, and request.

SHOW_GOLDENRECORD_QUICK

Calculate golden record for given request.

SHOW_GOLDENRECORD_STANDARD

Calculate golden record for given request.

Example: ["SHOW_DEBUG_INFO"]
dataSourcesArray of strings

Filter Data Sources used during lookup.

Example: "VIES"
curl -i -X POST \
  https://developer.cdq.com/_mock/apis/sap-odm-api/v2/api-v2/referencedata/rest/v3/businesspartners/lookup \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "businessPartner": {
      "addresses": [
        {
          "country": {
            "shortName": "DE"
          }
        }
      ],
      "names": [
        {
          "value": "SAP"
        }
      ]
    }
  }'

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)[ 1 .. 1000 ]

Number of items per page.

Default 10
Example: "100"
totalsinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
pageinteger(Page)>= 0

Current page number.

Default 0
Example: "1"
limitinteger(Limit)

Number of items per page.

Example: "100"
startAfterstring(StartAfter)

The ID which is used to read the page.

Example: "5712566172571652"
nextStartAfterstring(NextStartAfter)

Provides a value to be used as a startAfter in next page request.

Example: "5712566172571652"
valuesArray of objects(SapOdmBusinessPartnerLookupMatch)

List of Business Partner lookup matches.

goldenRecordobject(SapOdmGoldenRecord)

Golden Record for the given request. It contains the Golden Record Business Partner and the matching scores.

Response
application/json
{
  "pageSize": "100",
  "totals": "67",
  "page": "1",
  "limit": "100",
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "values": [
    { … }
  ],
  "goldenRecord": {
    "cdqId": "VIES:PL8660001429",
    "matchingProfile": { … },
    "businessPartner": { … }
  }
}

Fetch Business Partner

Request

Fetch business partner by CDQ-ID.

Security
apiKey
Bodyapplication/jsonrequired
cdqIdstring

CDQ ID for business partner and address.

Example: "VIES:PL8660001429"
featuresOnArray of strings(BusinessPartnerFetchFeature)

List of features to be activated.

Items ValueDescription
SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, and request.

Example: ["SHOW_DEBUG_INFO"]
featuresOffArray of strings(BusinessPartnerFetchFeature)

List of features to be deactivated.

Items ValueDescription
SHOW_DEBUG_INFO

Show additional information regarding request processing, including enabled features, and request.

Example: ["SHOW_DEBUG_INFO"]
curl -i -X POST \
  https://developer.cdq.com/_mock/apis/sap-odm-api/v2/api-v2/referencedata/rest/v3/businesspartners/fetch \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "example": "VIES:PL8660001429"
  }'

Responses

OK

Bodyapplication/json
statusstring

status:

  • OK - Service returned a correct response.
  • FAILED - Call to external service failed.
  • INVALID_INPUT - Given input parameter is invalid or entry not found.
  • AUTHORIZATION_FAILED - Authorization to external service does not succeed.
Example: "OK"
messagestring

Message describing the status of the request.

Example: "Service returned a correct response."
cdqIdstring

CDQ ID for Business Partner.

Example: "VIES:PL8660001429"
dataSourcestring(DataSourceTechnicalKey)

Technical key of the data source.

Example: "BR_RF"
businessPartnerobject(BusinessPartner)

An organizational entity engaged in various facets of another organization's business interactions. This collaborative connection often manifests as a customer, supplier, vendor, or service provider. In the CDQ (Corporate Data Quality) framework, the Business Partner assumes a pivotal role as a core managed entity. Each Business Partner is distinctly and globally identifiable through a unique CDQ ID. All pertinent information, including addresses, identifiers, and hierarchical data, is intricately associated with and linked to the specific Business Partner, ensuring comprehensive management and traceability within the system.

Response
application/json
{
  "status": "OK",
  "message": "Service returned a correct response.",
  "cdqId": "VIES:PL8660001429",
  "dataSource": "BR_RF",
  "businessPartner": {
    "names": [ … ],
    "legalForm": { … },
    "identifiers": [ … ],
    "addresses": [ … ],
    "externalId": "The ID managed in the customer's SAP systems.",
    "jsonRecord": { … },
    "types": [ … ]
  }
}