Skip to content

Data Matching API (2)

This API provides services for maintaining matching definitions used as configuration for matching jobs, as well as services for matching data with a job.

Overview
URL

https://www.cdq.ch/team

Sebastian Kaczmarski

sebastian.kaczmarski@cdq.ch

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/

Business Partner

Provides functionalities for managing business partners. These endpoints support matching business partners against data matching definitions, ensuring comprehensive analytics for data matching activities.

Operations

Analytics

Provides functionalities for generating and polling data matching reports. These endpoints support creating reports and checking their status, ensuring comprehensive analytics for data matching activities.

Operations

Data Matching

Provides functionalities for managing Data Matching Definitions, which are configurations for matching jobs to identify duplicates or link records across data sources. These endpoints support creating, reading, updating, and deleting these configurations.

Operations

Duplicate Matching

Provides functionalities for managing duplications within a single data source. These endpoints support creating Deduplication Job and checking the Deduplication Job Status.

Operations

Entity Matching

Provides functionalities for matching business partners. These endpoints support matching business partners against data matching definitions, ensuring comprehensive analytics for data matching activities.

Operations

Identity Resolution

Provides functionalities for managing identity resolution configurations and operations.

Operations

Linkage Matching

Provides functionalities for managing linkages across multiple data sources. These endpoints support creating Linkage Job and checking the Linkage Job Status.

Operations

Public

Provides functionalities for polling the Matching Reports.

Operations

User Feedback

Provides functionalities for managing user feedback related to data matching decisions.

Operations

List Duplication's Relations

Request

Get relations of duplication represented by identity links. Searching for these links, can be done by businessPartnerId which is unique among all of stored Business Partners in CDQ Cloud or storageId and externalId.

Security
basicAuth
Path
storageIdstringrequired

ID of an identity link storage.

Example: 65dcc3c60cecd503bcc88c92
Query
startAfterstring(StartAfter)

Indicator for the next page. Used together with nextStartAfter from the result.

Example: startAfter=5712566172571652
limitinteger(int32)>= 1

Number of items to be returned.

Default 20
Example: limit=100
businessPartnerIdstring(BusinessPartnerId)

Business Partner ID provided by CDQ that is unique across all stored Business Partners in CDQ Cloud. Used to filter results by this ID.

Example: businessPartnerId=63e635235c06b7396330fe40
externalIdstring(BusinessPartnerExternalId)

Business Partner External ID.

Example: externalId=The ID managed in the customer's SAP systems.
createdAtFromstring

Date in format yyyy-mm-ddTHH:mm:ss, used for filtering by createdAt.

Example: createdAtFrom=2021-01-01T00:00:00
createdAtTostring

Date in format yyyy-mm-ddTHH:mm:ss, used for filtering by createdAt.

Example: createdAtTo=2021-01-01T00:00:00
modifiedAtFromstring

Date in format yyyy-mm-ddTHH:mm:ss, used for filtering by createdAt.

Example: modifiedAtFrom=2021-01-01T00:00:00
modifiedAtTostring

Date in format yyyy-mm-ddTHH:mm:ss, used for filtering by createdAt.

Example: modifiedAtTo=2021-01-01T00:00:00
featuresOnArray of strings(IdentityLinksReadFeatureEnum)

Enable additional features.

Items ValueDescription
NUMBER_OF_TOTAL

When enabled it will fetch total number of records.

Example: featuresOn=NUMBER_OF_TOTAL
Headers
X-Credential-Usernamestringrequired

Parameter used for passing the username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/v2/linkstorages/65dcc3c60cecd503bcc88c92/businesspartners/duplicatelinks \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
valuesArray of objects(IdentityLinkSearchResult)

List of identity links results.

totalinteger(int32)

By default, this is disabled. To enable set NUMBER_OF_TOTAL in featuresOn if applicable.

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"
Response
application/json
{}

Duplication Relation Bulk Update

Request

Bulk update of relations of duplication.

Security
basicAuth
Path
storageIdstringrequired

ID of an identity link storage.

Example: 65dcc3c60cecd503bcc88c92
Headers
X-Credential-Usernamestringrequired

Parameter used for passing the username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/json
identityLinksArray of objects(IdentityLinkUpdate)

List of identity links to be updated.

curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/v2/linkstorages/65dcc3c60cecd503bcc88c92/businesspartners/duplicatelinks \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "identityLinks": [
      {
        "id": "65dcc3c60cecd503bcc88c92",
        "status": "MATCH"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
identityLinksArray of objects(IdentityLinkUpdateResult)
Response
application/json
{}

Duplication Relation Bulk Delete

Request

Bulk deletion of relations of duplication.

Security
basicAuth
Path
storageIdstringrequired

ID of an identity link storage.

Example: 65dcc3c60cecd503bcc88c92
Headers
X-Credential-Usernamestringrequired

Parameter used for passing the username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Bodyapplication/json
identityLinksArray of objects(IdentityLinkDelete)

List of identity links to be deleted.

curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/v2/linkstorages/65dcc3c60cecd503bcc88c92/businesspartners/duplicatelinks/delete \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "identityLinks": [
      {
        "id": "65dcc3c60cecd503bcc88c92"
      }
    ]
  }'

Responses

OK

Bodyapplication/json
identityLinksArray of objects(IdentityLinkDeleteResult)

List of identity links to be deleted.

Response
application/json
{}

Duplication Relation Details

Request

Get details of relation of duplication.

Security
basicAuth
Path
idstringrequired

Specifies the Identity Link by ID.

Example: 65dcc3c60cecd503bcc88c92
storageIdstringrequired

ID of an identity link storage.

Example: 65dcc3c60cecd503bcc88c92
Headers
X-Credential-Usernamestringrequired

Parameter used for passing the username. The header can take form of:

  • username (e.g. "lukaszmichta")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/v2/linkstorages/65dcc3c60cecd503bcc88c92/businesspartners/duplicatelinks/65dcc3c60cecd503bcc88c92 \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
idstring

ID of Identity Link.

Example: "65dcc3c60cecd503bcc88c92"
createdAtstring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
modifiedAtstring(ModifiedAt)

Date of modification (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
entityAobject(IdentityLinkEntity)

Identity Link entity.

entityBobject(IdentityLinkEntity)

Identity Link entity.

confidenceobject(MatchingConfidenceSearchResult)

Matching confidence search result.

linkStatusstring(LinkStatus)

Value of Link status.

Example: "INFERRED"
Response
application/json
{}

Configurations

Operations