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/
Bodyapplication/jsonrequired
Unique identifier of the Storage.
Example: "72d6900fce6b326088f5d9d91049e3e6"
If set, only the records that belong to the countries identified by these short names are processed. By default, all records of the storage (means from all countries) are processed (considering other filters).
Example: ["CH"]
If set, only the records that belong to the data sources identified by these IDs are processed. By default, all records of the storage (means from all data sources) are processed (considering other filters).
Example: ["648824a691d8d2503d65103e"]
If set, feedback from listed Matching Decision Logs will be considered.
Example: ["65dcb1d68f01e37c2cf9bbb2"]
Id of the data matching definition.
Example: "6461e6113b1865304b3038b6"
Allows setting the number of threads, batch size and profiling.
Parameters for reports generation for the Deduplication Job.
List of job dependencies that need to be fulfilled before this job can be started.
- Mock server
https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/public/v2/deduplicationjobs
- Production SOAP
https://api.corporate-data-league.ch/data-matching/soap/v2/public/v2/deduplicationjobs
- Production
https://api.corporate-data-league.ch/data-matching/public/v2/deduplicationjobs
curl -i -X POST \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/public/v2/deduplicationjobs \
-H 'Content-Type: application/json' \
-H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
-d '{
"storageId": "72d6900fce6b326088f5d9d91049e3e6",
"countryShortNames": [
"CH"
],
"dataSourceIds": [
"648824a691d8d2503d65103e"
],
"decisionLogIds": [
"65dcb1d68f01e37c2cf9bbb2"
],
"dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
"duplicateMatchingDukeProperties": {
"threads": "4",
"batchSize": "1000",
"profiling": "true"
},
"reportsRequest": {
"reportsConfiguration": {
"duplicateMatching": {
"build": "false",
"includeSingles": "false"
},
"duplicateConsolidation": {
"build": "false",
"includeSingles": "false"
}
},
"tags": [
"Custom tag"
]
},
"jobDependencies": [
{
"id": "35f23c03-1c22-45fe-9484-3ffe769325de",
"strategy": "SCHEDULE_NEXT_WHEN_ENDED"
}
],
"labels": [
{
"key": "labelKey",
"value": "labelValue"
}
],
"tags": [
"Custom tag"
]
}'OK
Unique identifier of the Storage.
Example: "72d6900fce6b326088f5d9d91049e3e6"
Id of the data matching definition.
Example: "6461e6113b1865304b3038b6"
List of Data Source IDs.
Example: ["648824a691d8d2503d65103e"]
If set, feedback from listed Matching Decision Logs will be considered.
Example: ["65dcb1d68f01e37c2cf9bbb2"]
Curation Job execution status.
| Enum Value | Description |
|---|---|
| ARCHIVED | The job is archived. |
| UNKNOWN | The job status is unknown. |
| CREATED | The job has been created. |
| PERSISTED | The job has been persisted. |
| SCHEDULED | The job is scheduled. |
| WAITING | The job is waiting. |
| COULDNT_START | The job could not be started. |
| RUNNING | The job is running. |
| FINISHED | The job has finished. |
| DIED | The job has died. |
Example: "RUNNING"
Response
application/json
{ "id": "35f23c03-1c22-45fe-9484-3ffe769325de", "storageId": "72d6900fce6b326088f5d9d91049e3e6", "dataMatchingDefinitionId": "6461e6113b1865304b3038b6", "dataSourceIds": [ "648824a691d8d2503d65103e" ], "decisionLogIds": [ "65dcb1d68f01e37c2cf9bbb2" ], "countryShortNames": [ "CH" ], "createdAt": "2020-08-31T16:47+00:00", "createdBy": "76248934691294444", "status": "RUNNING", "progress": "77" }
- Mock server
https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/public/deduplicationjobs/{id}
- Production SOAP
https://api.corporate-data-league.ch/data-matching/soap/v2/public/deduplicationjobs/{id}
- Production
https://api.corporate-data-league.ch/data-matching/public/deduplicationjobs/{id}
curl -i -X GET \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/data-matching-api/api-v2/public/deduplicationjobs/65dcc3c60cecd503bcc88c92 \
-H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'OK
Unique identifier of the Storage.
Example: "72d6900fce6b326088f5d9d91049e3e6"
Id of the data matching definition.
Example: "6461e6113b1865304b3038b6"
List of Data Source IDs.
Example: ["648824a691d8d2503d65103e"]
If set, feedback from listed Matching Decision Logs will be considered.
Example: ["65dcb1d68f01e37c2cf9bbb2"]
Curation Job execution status.
| Enum Value | Description |
|---|---|
| ARCHIVED | The job is archived. |
| UNKNOWN | The job status is unknown. |
| CREATED | The job has been created. |
| PERSISTED | The job has been persisted. |
| SCHEDULED | The job is scheduled. |
| WAITING | The job is waiting. |
| COULDNT_START | The job could not be started. |
| RUNNING | The job is running. |
| FINISHED | The job has finished. |
| DIED | The job has died. |
Example: "RUNNING"
Response
application/json
{ "id": "35f23c03-1c22-45fe-9484-3ffe769325de", "storageId": "72d6900fce6b326088f5d9d91049e3e6", "dataMatchingDefinitionId": "6461e6113b1865304b3038b6", "dataSourceIds": [ "648824a691d8d2503d65103e" ], "decisionLogIds": [ "65dcb1d68f01e37c2cf9bbb2" ], "countryShortNames": [ "CH" ], "createdAt": "2020-08-31T16:47+00:00", "createdBy": "76248934691294444", "status": "RUNNING", "progress": "77" }