Potential Matches Reindex Task
Learn more about how to reindex potential matches data for a tenant and when to run this background task manually.
The Potential Matches Reindex task rebuilds potential matches information for a tenant. It first removes old potential matches information from the tenant index and then reindexes potential matches information again from the match tables.
When to run this task
Run the Potential Matches Reindex task manually in when:
- You detected inconsistencies in the potential matches counters.
- You ran a Reindex Data Task without
enableSeparateIndexing=trueorenableSeparateCluster=trueand also need to refresh potential matches data. In that case,PotentialMatchesReindexTaskis not triggered automatically and must be started separately.
Note: When you run a Reindex Data Task with
enableSeparateIndexing=true or enableSeparateCluster=true, PotentialMatchesReindexTask is triggered automatically upon completion. You do not need to run it manually in that case.HTTP method and endpoint
Use the following HTTP method and endpoint to start the task:
Administrator role is required:
POST {ApplicationURL}/rebuildpmcountersTenant admin role is required:
POST {ApplicationURL}/api/{tenantId}/rebuildpmcountersQuery parameters
The following table describes the supported query parameters.
| Parameter | Required | Description |
|---|---|---|
tenantId | Yes | ID of the tenant to reindex potential matches. |
distributed | No |
If set to
true, the task runs in distributed mode. Default value is false. For more information, see Distributed mode. |
taskPartsCount | No |
Specifies the maximum number of sub-tasks for distributed execution. The platform determines the optimal number based on performance limits. Default value is
2. Note: This parameter is only applicable when distributed=true. Otherwise, it s ignored. |
filter | No | Enables filtering by condition. Use the following format for the filter query parameter:
If an entity matches the filter, its potential matches are reindexed. |