Linkage Matching

Poll Linkage Job Status

Check the status of a linkage job by its ID.

SecurityapiKey
Request
path Parameters
id
required
string

ID of the linkage job.

Example: 65dcc3c60cecd503bcc88c92
Responses
200

OK

401

Unauthorized

403

Forbidden

get/linkagejobs/{id}
Request samples 
Response samples 
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "patternSources": [
    ],
  • "matchSources": [
    ],
  • "countryShortNames": [
    ],
  • "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
  • "decisionLogIds": [
    ],
  • "createdAt": "2024-12-21T01:35:17Z",
  • "createdBy": "76248934691294444",
  • "status": "RUNNING",
  • "progress": "77"
}
Start Linkage Job
Initiate a new linkage job


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
ID of the DataMatchingDefinition that should be used to perform the link matching.


 
 Example:  "6461e6113b1865304b3038b6"
decisionLogIds
Array of strings
If set, feedback from listed Matching Decision Logs will be considered.


 
 Example:  ["65dcb1d68f01e37c2cf9bbb2"]
Array of objects (DataMatchingSource)   non-empty 
The source, in form of a BusinessPartner storage (at least one but can be more), to get the match records for the matching.


 
Array of objects (DataMatchingSource)   non-empty 
The source, in form of a BusinessPartner storage (at least one but can be more), to get the pattern records for the matching.


 
Responses 
200
OK


400
The sent request is malformed.


401
Unauthorized


403
Forbidden


post/linkagejobs
Request samples 
application/json
{
  • "patternSources": [
    ],
  • "matchSources": [
    ],
  • "countryShortNames": [
    ],
  • "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
  • "decisionLogIds": [
    ]
}
Response samples 
application/json
{
  • "id": "35f23c03-1c22-45fe-9484-3ffe769325de",
  • "patternSources": [
    ],
  • "matchSources": [
    ],
  • "countryShortNames": [
    ],
  • "dataMatchingDefinitionId": "6461e6113b1865304b3038b6",
  • "decisionLogIds": [
    ],
  • "createdAt": "2024-12-21T01:35:17Z",
  • "createdBy": "76248934691294444",
  • "status": "RUNNING",
  • "progress": "77"
}