Using the Delete APIs
The Data Lake API suite provides methods to delete data objects from Data Lake.
To purge data objects, use one of these methods:
- The
DELETE dataobjects/filter
method - A two-step approach by first calling the
GET dataobjects
method to receive the list of data object IDs and then purging data objects with theDELETE dataobjects/ids
method
If the selected filter parameter is an indexed timestamp such as
dl_document_indexed_date
, then apply a 5-second lag interval from the
highest indexed timestamp that was referenced during the call. This is to ensure that all
data objects are purged.
When purging from Purge API, the process does not clear the matching reformatted Compass data. You must manually clear the Compass data after purging. You can use the Compass API to run the clear data administration procedure. In the clear data parameters, use the object name and the oldest store date of the data objects that were purged.
To purge archived data, you must set the Include archived
parameter to
True.
Interface and consumption methods are exposed through the Data Lake API Service registered within the Data Fabric Suite in API Gateway.
For more information on how to use API Gateway and how to interact with Swagger documentation for the API methods, see ION documentation.
For instructions on how to clear the Compass data, see Clear data.