Reindex Activity Task
Reindexes activities in a tenant.
This task allows you to reindex all activities in a tenant. By default, only the previous month's activities are reindexed due to performance and storage size considerations.
Requests
Admin role is required:
POST {ApplicationURL}/reindexActivities Tenant admin role is required:
POST {ApplicationURL}/api/{tenantId}/reindexActivities | Name | Required | Description | |
|---|---|---|---|
| Headers | Authorization |
Yes | Information about authentication access token in format "Bearer
<accessToken>" (see details in Authentication API This endpoint is available
for tenant admins only. |
| Query | tenantId |
Yes | ID of the tenant to reindex activities. |
skipEntitiesCount |
No | The number of activities that are skipped during the reindexing
operation. Default is 0. |
|
updatedSince |
No | Timestamp in UNIX format. If this parameter is specified, then
activities with a greater or equal timestamp are
reindexed. |
|
distributed |
No | If set to true, the task runs in distributed mode
(see details in 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. |
|
Response
JSON Object representing a new task that has started.
Example
Request
POST http://localhost:8080/reindexActivities?tenantId=abcd
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512