Re-cleanse Data Task
Re-cleanse entities in a tenant.
The task re-cleanses entities in a tenant.
Stop and Pause are supported.
Requests
Tenant admin role is required:
POST {ApplicationURL}/cleanse
Tenant 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 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. |
Body (optional):
JSON Array of entity URIs to re-cleanse. Only these entities will be re-cleansed in this case.