POST api/catalog/maintenance/purge

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RetentionDays	integer	Range: inclusive between 7 and 365
Scope	string	Matching regular expression pattern: ^(safe\|full\|custom)$
Tables	Collection of string	None.
DryRun	boolean	None.
MaxRecordsPerTable	integer	Range: inclusive between 1 and 100000
ActivityLogRetentionDays	integer	Range: inclusive between 30 and 730

Request Formats

application/json, text/json

Sample:

{
  "RetentionDays": 1,
  "Scope": "sample string 2",
  "Tables": [
    "sample string 1",
    "sample string 2"
  ],
  "DryRun": true,
  "MaxRecordsPerTable": 1,
  "ActivityLogRetentionDays": 1
}

application/xml, text/xml

Sample:

<PurgeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TomJames.API.Areas.CatalogManagement.Models.Request">
  <ActivityLogRetentionDays>1</ActivityLogRetentionDays>
  <DryRun>true</DryRun>
  <MaxRecordsPerTable>1</MaxRecordsPerTable>
  <RetentionDays>1</RetentionDays>
  <Scope>sample string 2</Scope>
  <Tables xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tables>
</PurgeRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PurgeRequest'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.