Re-cleanse Data Task
Re-cleanse entities in a tenant.
The task re-cleanses entities in a tenant.
Stop and Pause are supported.
Requests
Admin role is required:
POST {ApplicationURL}/cleanseTenant admin role is required:
POST {ApplicationURL}/api/{tenantId}/cleanse| Parameter | Required | Description |
|---|---|---|
tenantId
|
Yes | ID of the tenant to re-cleanse entities. |
entityType
|
No | An entity type to check (all types will be checked if this parameter is absent). If provided, restricts re-cleanse to a specific entity type. |
skipEntitiesCount
|
No | A number of entities, which will be skipped during the re-cleanse.
Default is 0. |
updatedSince
|
No | Timestamp in UNIX format. If this parameter is specified, then only entities with greater or equal timestamp will be re-cleansed. |
distributed |
No | If set to true, the task will be run in distributed mode Default
value: false. |
taskPartsCount
|
No |
Number of tasks which will be created for distributed re-cleansing, each task will cleanse its own part of objects, and all of them may be executed on different API nodes in parallel. Recommended value: Count of API nodes which can execute the tasks.
Default value:
Note: This parameter is used only in distributed mode
(
distributed=true); otherwise, it is
ignored. |
Body (optional):
JSON Array of entity URIs to re-cleanse. Only these entities will be re-cleansed in this case.