Delete History Records Task
Learn about the DeleteHistoryRecordsTask and how it removes history records in Reltio within a specified date range.
DeleteHistoryRecordsTask is a periodic task that deletes transaction history records in a tenant. You define the deletion window using the historySinceDate and historyTillDate parameters.
The task permanently deletes history records and they cannot be restored.
HTTP method and endpoint
Use this endpoint to run the task for a specific tenant as a Tenant Admin. It requires a tenant-level admin role with permission to manage data.
POST {ApplicationURL}/api/{tenantId}/deleteHistoryRecords
Request headers
Use the following parameters to define the scope and behavior of the DeleteHistoryRecordsTask.
| Parameter | Required | Default | Description |
|---|---|---|---|
tenantId | Yes | None | The ID of the tenant whose history records will be deleted. |
distributed | No | false | If set to true, the task runs in distributed mode. |
taskPartsCount | No | 2 | Maximum number of tasks created for distributed execution. Each part processes its own subset of objects and can run on different API nodes in parallel. The actual number of tasks created may be fewer. |
historySinceDate | Yes | None | Date from which history records will be removed physically (inclusive). Accepts U.S. format (MM/dd/yyyy) or database formats like YYYY-MM-dd, YYYY-MM-dd'T'HH:mm:ss.SSSZ, YYYY/MM/dd HH:mm:ss. |
historyTillDate | Yes | None | Date until which history records will be removed physically (exclusive). |
Request Body
You can optionally provide a JSON array of entity URIs in the request body. If specified, the task deletes history records only for the listed entities. If you do not provide a request body, the task deletes history records for all entities in the tenant that match the specified date range.
The request body must be a valid JSON array in which each string value represents the URI of an entity.
Example request
The following example shows how a complete request is structured, including headers and a JSON body. The recommended maximum number of entities in the request body is 1000.
[
"entities/Uri1",
"entities/Uri2",
...
"entities/UriN"
]historySinceDate is inclusive and the historyTillDate is exclusive. The task deletes records created on or after historySinceDate and before historyTillDate. Records created exactly on historyTillDate are not deleted.