Skip to main content
Version: Any 26

JobCleanFormats

In Any, when a format (primary, PDF, thumbnail) is deleted or overwritten, it keeps being stored for a configurable period, so that contents that would have been deleted can be restored. This job permanently deletes the old formats that are past the retention period.

Parameters​

{
"batch_size": 100,
"job_clean_type": "delete_old_formats",
"job_clean_scan": "all",
"retention_period": "1y0m0d"
}

The job_clean_scan parameter can take the following values:

  • all: applies the job on every document.
  • filtered: applies the job only on the documents matching a GQL predicate. Add a filter parameter holding the predicate, for instance standard.status = 'Approved'.
  • query: applies the job only on the documents matching a GQL query. Add a query parameter holding the full query.

The batch_size parameter limits the number of documents updated at a time.

The retention_period parameter defines the retention period, expressed in years (y), months (m) and days (d). For instance, 1y6m0d is one year and six months.