Potential Matches Reindex Task
Information about how to reindex potential matches.
This task contains the following steps:
PotentialMatchesRemoveTask
- This task cleans old potential matches information in the tenant index.PotentialMatchesReindexTask
- This task reindexes the potential matches information from scratch by using the match tables.
You must run this task if inconsistencies are detected in the potential matches counters.
Stop and Pause actions are supported.
Requests
Administrator role is required:
POST {ApplicationURL}/rebuildpmcounters
Tenant admin role is required:
POST {ApplicationURL}/api/{tenantId}/rebuildpmcounters
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. For more information, see Distributed Mode. Default value is false . |
taskPartsCount |
No | Number of tasks which are created for distributed reindexing. Each
task reindexes its own part of objects, and all of them can be executed
on different API nodes in parallel. Recommended value: count of API
nodes which can execute the tasks. Default value is 2 .
Note: This parameter is used only in distributed mode
( distributed=true ); otherwise, it is
ignored. |
filter |
No | Enables filtering by a condition. The format for the filter query
parameter is as follows:
If an entity matches the filter, then its potential matches are reindexed |