Duplicate Matching

Poll Deduplication Job Status

Polls the status of the Deduplication Job.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the deduplication job.

Example: 65dcc3c60cecd503bcc88c92
Responses
200

OK

401

Unauthorized

403

Forbidden

get/deduplicationjobs/{id}
Request samples
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
  • "dataSourceIds": [
    ],
  • "decisionLogIds": [
    ],
  • "countryShortNames": [
    ],
  • "createdAt": "2024-07-11T07:22:19Z",
  • "createdBy": "76248934691294444",
  • "status": "RUNNING",
  • "progress": "77"
}

Start Deduplication Job V2

Starts a Deduplication Job for the given storage.

SecurityapiKey
Request
Request Body schema: application/json
required
countryShortNames
Array of strings (CountryShortName)

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"]
dataMatchingDefinitionId
string (DataMatchingDefinitionId)

Id of the data matching definition.

Example: "6461e6113b1865304b3038b6"
dataSourceIds
Array of strings (BusinessPartnerStorageDataSourceId)

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"]
decisionLogIds
Array of strings

If set, feedback from listed Matching Decision Logs will be considered.

Example: ["65dcb1d68f01e37c2cf9bbb2"]
object (DuplicateReportsRequestParams)

Parameters for reports generation for the Deduplication Job.

storageId
string (BusinessPartnerStorageId)

Unique identifier of the Storage.

Example: "72d6900fce6b326088f5d9d91049e3e6"
Responses
200

OK

401

Unauthorized

403

Forbidden

post/v2/deduplicationjobs
Request samples
application/json
{
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "countryShortNames": [
    ],
  • "dataSourceIds": [
    ],
  • "decisionLogIds": [
    ],
  • "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
  • "reportsRequest": {
    }
}
Response samples
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "storageId": "72d6900fce6b326088f5d9d91049e3e6",
  • "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
  • "dataSourceIds": [
    ],
  • "decisionLogIds": [
    ],
  • "countryShortNames": [
    ],
  • "createdAt": "2024-07-11T07:22:19Z",
  • "createdBy": "76248934691294444",
  • "status": "RUNNING",
  • "progress": "77"
}