Purge a deleted record, optionally including linked ones if any.
Use the purge record operation to fully remove the deleted record data from the system.
Purge does not delete record IDs or external IDs associated with the record; it purges only the data object from the deleted record.
Optionally, you can:
- Preview the IDs that would be purged by setting the
dryRunparameter totrue. - Purge data objects for any linked deleted records by setting the
cascadingparameter totrue.
When supplying the recordId parameter, you can provide any ID that resolves to a deleted record, including:
- Record ID (the ID of the record in the RealTime datastore)
- External ID associated with the record
- Tamr ID (the ID assigned by Tamr to the mastered entity and its clustered source records)
- Tamr record ID (the unique identifier for the source record, generated by Tamr. This identifier is a 128-bit hash value of the source dataset name and the source primary key.)
Example 1: Purging a merged record
In this example, rec_1 has been merged into rec_2.
If rec_1 is purged with cascading set to false, only the rec_1 data object is purged.
If rec_1 is purged with cascading set to true, the data objects for both rec_1 and rec_2 are purged.
Example 2: Purging a record with an external ID
In this example, rec_3 has an externalId extID_abc.
If rec_3 is purged, its data object is purged, but the link between rec_3 and the external ID extID_abc is not removed.
Similarly, if extID_abc is purged, the data object for the linked rec_3 is purged, but the link between rec_3 and the external ID extID_abc is not removed.
Getting purge history for either rec_3 or extID_abc returns the same response.