Reindex Activity Log Records
Reindexes activity log records in a tenant
This task allows you to reindex all activity log records in a tenant. By default, only
previous month activitiy logs are reindexed due to performance and storage size
considerations. To reindex all activities in Elastic Search (ES), the
activityFullReindex
parameter must be used. However, this can cause
significant load on ES and performance degradation.
Requests
ADMIN_ROLE
is required:
POST {ApplicationURL}/reindexActivities
ADMIN_ROLE
or tenant admin roles are required:
POST {ApplicationURL}/api/{tenantId}/reindexActivities (ADMIN_ROLE or tenant admin roles are required)
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 activity log records . |
skipEntitiesCount |
No | The number of activity log records that will be skipped during the
reindexing. Default: 0 . |
|
updatedSince |
No | Timestamp in UNIX format. If this parameter is specified, then
activity log records with a greater or equal timestamp
are reindexed. |
|
activityFullReindex |
No | If true , reindexes all activities in ES. If false or
not specified, only previous month activities are reindexed. |
|
distributed |
No | If set to true , the task is run in distributed mode
(see details in Distributed Mode). |
|
taskPartsCount |
No | Number of tasks that are created for distributed reindexing. Each
task reindexes its own part of objects, and all of them may be executed
on different API nodes. Recommended value: count of API nodes which can
execute the tasks. 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.
POST http://localhost:8080/reindexActivities?tenantId=abcd
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512