ArcGIS REST API

Cleanup Change Tracking

Description

Change tracking information stored in each feature service layer (enabled for Change Tracking) might grow very large. The change tracking info used by the feature service to determine the change generation number and the features that have changed for a particular generation. Clients can purge the change tracking content if the changes are already synced-up to all clients and the changes are no longer needed.

The change tracking cleaned only supported on the feature service admin API. Only the owner or the organization administrator can cleanup change tracking information.

Request Parameters

ParameterDetails
layers

Description: A comma separated list of the layers.

Syntax: layers=[<layer1>, <layer2>]

Example: layers=0,1,2 or layers=[0,1,2]

retentionPeriod

Description: The retention period to use when cleaning up the change tracking information. Change tracking information will be cleaned up if they are older than the retention period.

Example: retentionPeriod=30

retentionPeriodUnits

Description: The units of the retention period.

Syntax: "retentionPeriodUnits" : <days | seconds, minutes, hours>

Example: "retentionPeriodUnits" : "days"

minServerGen

Description: In addition to the retention period, the change tracking can be cleaned by its generation numbers. Older tracking information that has older generation number than the minServerGen will be cleaned.

Example: "minServerGen" : 56000000

replicaId

Description: The change tracking can also be cleaned by the replicaId in addition to the retentionPeriod and the minServerGen.

Example: "replicaId" : "b62e9db7-507c-443d-3473-8a1f7a7e9fa"

async

Description: Support options for asynchronous processing. The default format is false.

Value: true | false

f

Description: The response format. The default value is html.

Value: json | html

Example Usage

Example 1: https://services.myserver.com/<tenant>/ArcGIS/rest/admin/services/USA/FeatureServer/cleanupChangeTracking

Parameters:

"layer" : 0

"retentionPeriod" : 60

"retentionPeriodUnits" : "days"

"f" : "json"

JSON Response Example

{"success" : true}