Skip to content

Referencedata API (3)

This API provides services to search and read reference data

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

https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/

Production

https://api.cdq.com/referencedata/rest/

Business Partners

Everything about Business Partners

Operations

Addresses

Everything about Addresses

Analytics

Everything about reference data analytics

Configurations

Operations

Configuration

Operations

Processing Logs

Operations

List Processing Log Results

Request

Retrieves latest overlap results persisted in Processing Log.

Data is populated only when Data Monitor is configured for provided storage.

Security
apiKey
Path
storageIdstring(BusinessPartnerStorageId)required

Business Partner Storage ID.

Example: 72d6900fce6b326088f5d9d91049e3e6
Query
businessPartnerIdArray of strings(BusinessPartnerId)<= 500 items

Business Partner IDs.

Example: businessPartnerId=63e635235c06b7396330fe40
dataSourceIdstring(BusinessPartnerStorageDataSourceId)

Business Partner Data Source ID.

Example: dataSourceId=648824a691d8d2503d65103e
externalIdArray of strings(BusinessPartnerExternalId)<= 500 items

Business Partner External IDs.

Example: externalId=The ID managed in the customer's SAP systems.
startAfterstring(StartAfter)

Used to retrieve the next page of results.

Example: startAfter=5712566172571652
limitinteger(int32)[ 1 .. 100 ]

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

Default 100
Example: limit=50
fromstring

ISO 8601 representation of the timestamp when the result since when data was created.

Example: from=2025-09-12T14:57:59Z
tostring

ISO 8601 representation of the timestamp when the result until when data was created.

Example: to=2025-09-12T14:57:59Z
featuresOnArray of strings(ProcessingLogResultsReadFeatureEnum)

Features to be activated.

Items Enum"FILTER_BY_ENABLED_AUGMENTATION_MONITORS""NUMBER_OF_TOTAL""SHOW_LOOKUP_RESULTS"
Example: featuresOn=FILTER_BY_ENABLED_AUGMENTATION_MONITORS
featuresOffArray of strings(ProcessingLogResultsReadFeatureEnum)

Features to be deactivated.

Items Enum"FILTER_BY_ENABLED_AUGMENTATION_MONITORS""NUMBER_OF_TOTAL""SHOW_LOOKUP_RESULTS"
Example: featuresOff=FILTER_BY_ENABLED_AUGMENTATION_MONITORS
curl -i -X GET \
  https://developer.cdq.com/_mock/apis/referencedata-api/api-v3/v3/overlaplogs/72d6900fce6b326088f5d9d91049e3e6/results \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
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"
limitinteger(Limit)

Number of items per page.

Example: "100"
fromstring

ISO 8601 representation of the timestamp when the result since when data was created.

Example: "2025-09-12T14:57:59Z"
tostring

ISO 8601 representation of the timestamp when the result until when data was created.

Example: "2025-09-12T14:57:59Z"
totalinteger(PageTotal)

Total number of items which can be paged.

Example: "67"
valuesArray of objects(OverlapProcessingLogResult)

List of Overlap Processing Log Results.

Response
application/json
{
  "startAfter": "5712566172571652",
  "nextStartAfter": "5712566172571652",
  "limit": "100",
  "from": "2025-09-12T14:57:59Z",
  "to": "2025-09-12T14:57:59Z",
  "total": "67",
  "values": [
    { … }
  ]
}

Batch Lookup

Operations