(Required)

The ID of the replica you want to synchronize.

replicaID=<replicaID>

replicaID={90F07F7B-991C-4818-B7CA-97B2BF4F7CAA}

replicaServerGen is a generation number that allows the server to keep track of what changes have already been synchronized. A new replicaServerGen is sent with the response to the synchronizeReplica operation. Clients should persist this value and use it with the next synchronizeReplica call. It applies to replicas with syncModel = perReplica.

For replicas with syncModel = perLayer, layer generation numbers are specified using parameter: syncLayers; and replicaServerSibGen is not needed.

replicaServerGen=<replicaServerGen>

replicaServerGen=2

replicaServerSibGen is a generation number that allows the server to keep track of what changes have already been received. It is set when synchronizing where syncModel is perReplica and targetType is server. The replicaServerSibGen is updated in the replica metadata on the replica resource once the process completes successfully. This value is not set for replicas where the targetType is client.

Replicas with the server targetType are designed to allow syncing between services. When syncing, the replicaServerSibGen value is derived from the replicaServerGen of the other services matching replica. For replicas with perLayer as syncModel, layer generation numbers are specified using parameter: syncLayers; and replicaServerGen is not needed.

replicaServerSibGen=<replicaServerSibGen>

replicaServerSibGen=2

transportType represents the response format. If the transportType is esriTransportTypeUrl, the operation's response is contained in a file, and the URL link to the file is returned. Otherwise, the JSON object is returned directly in the response. The default is esriTransportTypeUrl. Note that for asynchronous processing (async=true), or when the response is returned in sqlite (dataFormat=sqlite ), results are always returned via URL regardless of how the parameter is set.

Values: esriTransportTypeUrl | esriTransportTypeEmbedded

If true, the replica will be unregistered when the synchronize completes. This is the same as calling synchronize and then calling unregisterReplica. Otherwise, the replica can continue to be synchronized. The default is false.

Values: true | false

If true, the objectIDs and globalIDs of features added during the synchronize will be returned to the client in the addResults sections of the response. Otherwise, the IDs are not returned. The default is false.

Values: true | false

The edits the client wants to apply to the service. Alternatively, the editsUploadID and editsUploadFormat can be used to specify the edits in a delta file.

The edits are described using an array where an element in the array includes:

• The layer or table ID
• The feature or row edits to apply listed as inserts, updates, and deletes
• The attachments to apply listed as inserts, updates, and deletes

For features, adds and updates are specified as feature objects that include geometry and attributes. Deletes can be specified using globalIDs for features and attachments. For attachments, updates and adds are specified using the following set of properties for each attachment. If embedding the attachment, set the data property; otherwise, set the url property. All other properties are required:

• globalid—The globalID of the attachment that is to be added or updated.
• parentGlobalid—The globalID of the feature associated with the attachment.
• contentType—Describes the file type of the attachment (for example, image/jpeg).
• name—The file name (for example, hydrant.jpg).
• data—The base 64 encoded data if embedding the data. Only required if the attachment is embedded.
• url—The location where the service will upload the attachment file (for example, https://machinename/arcgisuploads/Hydrant.jpg). Only required if the attachment is not embedded.

edits=[
	 {
	   "id": <layerId1>,
	   "features": {
		    "adds": [<feature1>, <feature2>],
		    "updates": [<feature1>, <feature2>],
		    "deleteIds": [<globalID1>, <globalID2>]
    },
	   "attachments": {
		    "adds": [ <attachment1>, <attachment2>],
		    "updates": [ <attachment1>, <attachment2>],
		    "deleteIds": [ <attachment1>, <attachment2>]
    }
	 },
	 { 
	   "id": <layerId2>,
	   "features": {
		    "adds": [<feature1>, <feature2>],
		    "updates": [<feature1>, <feature2>],
		    "deleteIds": [<globalID1>, <globalID2>]
    },
	   "attachments": {
		    "adds": [<attachment1>, <attachment2> ],
		    "updates": [<attachment1>, <attachment2> ],
		    "deleteIds": [ <globalID1>, <globalID2> ]
    }
	 }
]

edits=[
  {
    "id": 1,
    "features": { 
      "adds": [ 
        {
          "geometry": {
            "x": -178.24479999999991,
            "y": 50.012500000000045
          },
          "attributes": {
	           "globalID":"{8991B712-D26F-407d-9116-06B0CEF0F010}",
            "datetime": 1272210710000,
            "depth": 31.100000000000001,
            "eqid": "2010vma5",
            "latitude": 50.012500000000003,
            "longitude": -178.2448,
            "magnitude": 4.7999999999999998,
            "numstations": 112,
            "region": "Andreanof Islands, Aleutian Islands, Alaska",
            "source": "us",
            "version": "Q"
          }
        }
      ],
      "updates": [
        {
          "geometry": {
            "x": -178.24479999999991,
            "y": 50.012500000000045
          },
          "attributes": {
	           "globalID":"{59229CA9-4DF2-4d4d-B6A3-5504D08C1F7A}",
            "datetime": 1272210710000,
            "depth": 31.100000000000001,
            "eqid": "2010vma5",
            "latitude": 50.012500000000003,
            "longitude": -178.2448,
            "magnitude": 4.7999999999999998,
            "numstations": 112,
            "region": "Andreanof Islands, Aleutian Islands, Alaska",
            "source": "us",
            "version": "Q"
          }
        }    
	     ],
      "deleteIds": [
	       "{AAB7CD51-AA70-4a99-B3F6-E71E5D356758}",
	       "{47EC4FF1-C748-456b-B9DF-AC9F32A9EDBC}"
      ]
    },  
    "attachments": { 
      "adds": [ 
	       {
  	       "globalId": "{6CD00D29-F37E-4e77-9C74-361B719A42DB}",
	         "parentGlobalId": "{8991B712-D26F-407d-9116-06B0CEF0F010}",// feature's id
	         "contentType": "image/pjpeg"
	         "name: "Hydrant101.jpg"
	         "url: "https://machinename/arcgisuploads/Hydrant101.jpg"
	       }
      ],
      "updates" : [ 
	       {
	         "globalId" : "{934D1E05-BC1D-4d45-961A-4892C8C65135}",
	         "contentType":"image/pjpeg"
	         "name:"Hydrant202.jpg"
	         "url:"https://machinename/arcgisuploads/Hydrant202.jpg"
	       }
      ],
      "deleteIds": [
	       "{3048BF42-425B-48f4-8C2B-E3797EF9C64C}",
	       "{6E562021-B13F-4915-9218-3D93B483F8DA}"
      ]
    } //end of attachments
  }, //end of layer 1 data
  {
    "id": 5,
    "features": {
      "adds": [
        {
          "geometry": {
            "x": 242.24556961400003,
            "y": 34.260686249000059
          },
          "attributes": {
	           "globalId": "{50EBEDE7-8C9B-4bb5-95B5-1C78B8A90D76}",
            "type": 0,
            "description": "California Fire Department"
          }
        },
        {
          "geometry": {
            "x": 242.44111296000005,
            "y": 34.266616200000044
          },
          "attributes": {
	           "globalId": "{022265BD-5153-4b59-B62D-27D3C051528D}",
            "type": 6,
            "description": "San Gorgonio mountain"
          }
        }
      ],
      "updates": [
        {
          "geometry": {
            "x": 242.21472194300009,
            "y": 34.33949752500007
          },
          "attributes": {
	           "globalId": "{14CAFE0D-A9E0-4467-9905-06DC31E9C76B}",
            "type": 1,
            "description": "100 bed shelter."
          }
        },
        {
          "geometry": {
            "x": 242.17137744600006,
            "y": 34.259303879000072
          },
          "attributes": {
	           "globalId": "{89682769-E960-4a07-BC57-19634AAD7638}",
            "type": 5,
            "description": "gutted ranger station"
          }
        }
      ],
      "deleteIds": [ 
	       "{0AA0E51C-0B3D-45b8-92EE-7E5E4329BF03}",
	       "{DE708C1C-ACAF-4a75-8815-1BE35B06CC38}"
      ]
    } //end of features
  } //end of layer 2 data
] //end of layers

If true, a reference to a URL will be provided for each attachment returned from synchronizeReplica. Otherwise, attachments are embedded in the response. The default is true. This only applies only if attachments are included in the replica.

Values: true | false

If true, the request is processed as an asynchronous job and a URL is returned that a client can visit to check the status of the job. See the topic on asynchronous usage for more information. The default is false.

Values: true | false

Determines whether to upload, download, or upload and download on sync. By default, a replica is synchronized bi-directionally. Only applicable when syncModel = perReplica. If syncModel = perLayer, sync direction is specified using syncLayers. The following values are accepted by this parameter:

• download—The changes that have taken place on the server since last download are returned. Client does not need to send any changes. If the changes are sent, service will ignore them.
• upload—The changes submitted in the edits or editsUploadID/editsUploadFormatt parameters are applied, and no changes are downloaded from the server.
• bidirectional—The changes submitted in the edits or editsUploadID/editsUploadFormat parameters are applied, and changes on the server are downloaded. This is the default value.
• snapshot—The current state of the features is downloaded from the server. If any edits are specified, they will be ignored.

Values: download | upload | bidirectional | snapshot

syncLayers allows a client to specify layer-level generation numbers for a sync operation. It can also be used to specify sync directions at layer-level. This parameter is needed for replicas with a syncModel of perLayer. It is ignored for replicas with a syncModel or perReplica.

serverGen is required for layers with syncDirection = bidirectional or download.

serverSibGen is needed only for replicas where the targetType is server. For replicas with a syncModel of perLayer, the serverSibGen serves the same purpose at the layer level as the replicaServerSibGen does in the case of a perReplica syncModel. See the replicaServerSibGenparameter for more information.

If a sync operation has both the syncDirection and syncLayersparameters, and the replica's syncModel is perLayer, the layers that do not have syncDirection values will use the value of the syncDirection parameter. If the syncDirection parameter is not specified, the default value of bidirectional is used.

syncLayers=[
  {
    "id": <layerId1>,
    "serverGen": <genNum1>,
    "serverSibGen": <sibGenNum1>,
    "syncDirection": "syncDirection1"
  },
  {
    "id": <layerId2>,
    "serverGen": <genNum2>,
    "serverSibGen": <sibGenNum2>,
    "syncDirection": "syncDirection2"
  }
]

syncLayers=[
  {
    "id": 0,
    "serverGen": 1000,
    "syncDirection": "download"
  },
  {
    "id": 1,
    "serverGen": 1100,
    "syncDirection": "upload"
  },
  {
    "id": 2,
    "serverGen": 1200,
    "syncDirection": "bidirectional"
  },
  {
    "id": 3,
    "syncDirection": "snapshot"
  }
]

The ID for the uploaded item that contains the edits the client wants to apply to the service. Used in conjunction with editsUploadFormat.

editsUploadID={300B4F9C-FAD6-4af3-88FD-DE77621FAFDD}

The data format of the uploaded data reference in editsUploadId .

Values: sqlite

The data format for the returned data.

Values: json | sqlite

Determines the behavior when there are errors while importing edits on the server during synchronization. This only applies in cases where edits are being uploaded to the server (either upload or bidirectional for syncDirection). See the RollbackOnFailure and Sync Models topic for more details. If the supportsRollbackOnFailure property is false, the synchronizeReplica operation does not support the parameter.

When true, if an error occurs while importing edits on the server, all edits are rolled back (not applied), and the operation returns an error in the response. Use this setting when the edits are such that you will either want all or none applied. When false, the import process instead skips the edit and continues. All edits that were skipped are returned in the edits results with information describing why the edits were skipped.

Values: true | false

Introduced at ArcGIS Enterprise 11.0. This parameter applies to replicas created from branch versioned data where the service has the versionPerDownloadedMap setting. Replicas created from these services will have an associated replica branch version. When set to true, the operation automatically reconciles the replica branch version with the default branch upon sync. The default value is false.

Values: true | false

Setting timeReferenceUnknownClient as trueindicates that the client is capable of working with data values that are not in UTC. If its not set to true, and the service layer's datesInUnknownTimeZone property is true, then an error is returned. The default is false

Its possible to define a service's time zone of date fields as unknown. Setting the time zone as unknown means that date values will be returned as-is from the database, rather than as date values in UTC. Non-hosted feature services can be set to use an unknown time zone using ArcGIS Server Manager. Setting the time zones to unknown also sets the datesInUnknownTimeZone layer property as true. Currently, hosted feature services do not support this setting. This setting does not apply to editor tracking date fields which are stored and returned in UTC even when the time zone is set to unknown.

Most clients released prior to ArcGIS Enterprise 10.9 will not be able to work with feature services that have an unknown time setting. The timeReferenceUnknownClient parameter prevents these clients from working with the service in order to avoid problems.. Setting this parameter to true indicates that the client is capable of working with unknown date values that are not in UTC.

Value: true | false

The response format. The default response format is html.

Values: html | json