This API provides services for maintaining matching definitions used as configuration for matching jobs, as well as services for matching data with a job.
Data Matching API (2)
Overview
URL
Sebastian Kaczmarski
Languages
Servers
Mock server
https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/
Production SOAP
https://api.corporate-data-league.ch/data-matching/soap/v2/
Production
https://api.corporate-data-league.ch/data-matching/
Query
Minimum matching score threshold
Default 0.8
Example: matchingScore=0.8
Unique Data Monitor identifier
Example: dataMonitorId=72d6900fce6b326088f5d9d91049e3e6
Return only entity matching links associated with the specified Business Partner IDs. Provide an array of Business Partner IDs to filter the results. Maximum 500 IDs can be specified. To provide multiple values, use a comma-separated list: businessPartnerIds=bpId1,bpId2. You can also pass them separately as multiple query parameters: businessPartnerIds=bpId1&businessPartnerIds=bpId2.
Example: businessPartnerIds=63e635235c06b7396330fe40
Status of the entity matching link
| Enum Value | Description |
|---|---|
| INFERRED | This status means that the link was identified as a result of the matching process. It is purely algorithm based. |
| ASSERTED | This status means that the link was manually reviewed and approved. |
| RETRACTED | Status was |
Example: status=INFERRED
Indicator for the next page. Used together with nextStartAfter from the result.
Example: startAfter=5712566172571652
Enable additional features for entity matching links.
| Items Value | Description |
|---|---|
| NUMBER_OF_TOTAL | When enabled it will fetch total number of records. |
Example: featuresOn=NUMBER_OF_TOTAL
Unique Storage's Data Source identifier.
Example: dataSourceId=648824a691d8d2503d65103e
Return entries which were created before given date. The given date should support ISO-8601 representation.
Example: createdBefore=2024-01-01T00:00:00Z
Return entries which were created after given date. The given date should support ISO-8601 representation.
Example: createdAfter=2024-01-01T00:00:00Z
Business Partner externalIDs. To provide multiple values, use a comma-separated list: externalIds=extId1,extId2. You can also pass them separately as multiple query parameters: externalIds=extId1&externalIds=extId2.
Example: externalIds=The ID managed in the customer's SAP systems.
Filter by link confidence status.
Enum"MATCH""NO_MATCH""POSSIBLE_MATCH"
Example: confidenceStatus=MATCH
Defines the attributes to sort by. Supported attribute is 'matchingScore'. Sort direction can be specified in front of each attribute. '+' means ascending, '-' means descending. If direction is not given default sort is '-matchingScore'.
Default "-matchingScore"
Example: sort=-matchingScore
- Mock server
https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/entityresolution/entitymatchinglinks
- Production SOAP
https://api.corporate-data-league.ch/data-matching/soap/v2/entityresolution/entitymatchinglinks
- Production
https://api.corporate-data-league.ch/data-matching/entityresolution/entitymatchinglinks
curl -i -X GET \
-u <username>:<password> \
'https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/entityresolution/entitymatchinglinks?matchingScore=0.8&dataMonitorId=72d6900fce6b326088f5d9d91049e3e6'Response
application/json
{ "limit": 20, "total": 125, "startAfter": "aXhcYWdlIjoxLCJzaXplIjoyMH0=", "nextStartAfter": "eyJwYWdlIjoyLCJzaXplIjoyMH0=", "values": [ { … } ] }
Bodyapplication/jsonrequired
Entity link status update enum (excludes INFERRED)
| Enum Value | Description |
|---|---|
| ASSERTED | Manually verified and approved as a correct match |
| RETRACTED | Manually marked as incorrect match or duplicate |
Example: "RETRACTED"
- Mock server
https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/entityresolution/entitymatchinglinks/{id}
- Production SOAP
https://api.corporate-data-league.ch/data-matching/soap/v2/entityresolution/entitymatchinglinks/{id}
- Production
https://api.corporate-data-league.ch/data-matching/entityresolution/entitymatchinglinks/{id}
curl -i -X PATCH \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/entityresolution/entitymatchinglinks/5712566172571652 \
-H 'Content-Type: application/json' \
-d '{
"linkStatus": "RETRACTED",
"linkStatusUserComment": "Small Update - completely wrong duplicate"
}'Successfully updated entity matching link
Link status enum.
| Enum Value | Description |
|---|---|
| INFERRED | This status means that the link was identified as a result of the matching process. It is purely algorithm based. |
| ASSERTED | This status means that the link was manually reviewed and approved. |
| RETRACTED | Status was |
Example: "INFERRED"
User comment associated with the status change
Example: "Small Update - completely wrong duplicate"
Date of modification (ISO 8601-compliant).
Example: "2020-08-31T16:47+00:00"
User or Client UUID which modified the resource.
Example: "76248934691294444"
Response
application/json
{ "id": "5712566172571652", "linkStatus": "INFERRED", "linkStatusUserComment": "Small Update - completely wrong duplicate", "modifiedAt": "2020-08-31T16:47+00:00", "modifiedBy": "76248934691294444", "status": { "code": "200", "technicalKey": "OK", "details": [ … ], "path": "/v2/businesspartners/lookup", "timestamp": "2019-08-31T16:47+00:00" } }