Merge

URL:: https://<root>/<serviceName>/ParcelFabricServer/merge
Methods:: POST
Required Capability:: ArcGIS Advanced Editing
Version Introduced:: 10.8

Description

The merge operation creates a new parcel by merging two or more existing parcels in the parcel fabric. Adjacent parcels can be merged to create a single parcel and disjoint parcels can be merged to create multipart parcels. The original parent parcels will be retired as historic.

Learn more about merging parcels

Request parameters

Parameter Details

Parameter	Details
`gdbVersion` (Required)	Introduced at 10.8. The name of the geodatabase version (the default is the `DEFAULT` version). Syntax Use dark colors for code blocksCopy `1 gdbVersion=<version>`
`sessionId` (Required)	Introduced at 10.8. The token (GUID) used to lock the version. If the calling client is editing a named version, the `sessionId` value is required. If the specified version is currently locked by another session, the request will fail if the `sessionId` value is not provided or does not match the `sessionId` value that holds the exclusive lock. If the client is editing the default version, the `sessionId` value is not required. Syntax Use dark colors for code blocksCopy `1 sessionId=<guid>`
`parentParcels` (Required)	Introduced at 10.8. The parent parcels that will be merged. Syntax Use dark colors for code blocksCopy `1 parentParcels=[{"id":"<parcelguid>","layerId":"<layerID>"},{...}]`
`record` (Required)	Introduced at 10.8. The unique identifier (GUID) of the record that will be used for the merge. Merged parcels will be associated with the specified record. Syntax Use dark colors for code blocksCopy `1 record=<guid>`
`targetParcelType` (Required)	Introduced at 10.8. The parcel type (ID) in which the new, merged parcel will be created. Syntax Use dark colors for code blocksCopy `1 targetParcelType=<layer id>`
`mergeInto` (Optional)	Introduced at 10.8. The parent parcel into which the other parcels will be merged. Merging parcels into existing parcels will not create historic parcels. Syntax Use dark colors for code blocksCopy `1 mergeInto=<parcelguid>`
`defaultAreaUnit` (Required)	Introduced at 10.8. The default area units that will be used when calculating the stated area of the merged parcel. The stated area of the merged parcel will be calculated if the stated areas exist on the parcels being merged. Syntax Use dark colors for code blocksCopy `1 defaultAreaUnit=<area unit code>`
`attributeOverrides` (Required)	Introduced at 10.8. A list of attributes that will be used to override and replace attributes on the new merged parcel. Syntax Use dark colors for code blocksCopy `1 2 3 4 attributeOverrides={"type":"PropertySet","propertySetItems":["<FieldName>",<value>,"<FieldName>",<value>,.....,"IsSeed",0]} //If not overriding any attributes attributeOverrides={"type":"PropertySet","propertySetItems":["isseed",0]}`
`async` (Optional)	Introduced at 11.1. Specifies whether the request will be processed as an asynchronous job and a URL that points to a location displaying the status of the job will be returned. See the topic regarding asynchronous usage for more information. The default is `false`. Values: `true` \| `false` Syntax Use dark colors for code blocksCopy `1 async=true\|false`
`f`	The response format. The default response format is `html`. Values: `html` \| `json`

gdbVersion

(Required)

Introduced at 10.8.

The name of the geodatabase version (the default is the DEFAULT version).

Syntax

Use dark colors for code blocksCopy
gdbVersion=<version>

sessionId

(Required)

Introduced at 10.8.

The token (GUID) used to lock the version. If the calling client is editing a named version, the sessionId value is required. If the specified version is currently locked by another session, the request will fail if the sessionId value is not provided or does not match the sessionId value that holds the exclusive lock. If the client is editing the default version, the sessionId value is not required.

Syntax

Use dark colors for code blocksCopy
sessionId=<guid>

parentParcels

(Required)

Introduced at 10.8.

The parent parcels that will be merged.

Syntax

Use dark colors for code blocksCopy
parentParcels=[{"id":"<parcelguid>","layerId":"<layerID>"},{...}]

record

(Required)

Introduced at 10.8.

The unique identifier (GUID) of the record that will be used for the merge. Merged parcels will be associated with the specified record.

Syntax

Use dark colors for code blocksCopy
record=<guid>

targetParcelType

(Required)

Introduced at 10.8.

The parcel type (ID) in which the new, merged parcel will be created.

Syntax

Use dark colors for code blocksCopy
targetParcelType=<layer id>

mergeInto

(Optional)

Introduced at 10.8.

The parent parcel into which the other parcels will be merged. Merging parcels into existing parcels will not create historic parcels.

Syntax

Use dark colors for code blocksCopy
mergeInto=<parcelguid>

defaultAreaUnit

(Required)

Introduced at 10.8.

The default area units that will be used when calculating the stated area of the merged parcel. The stated area of the merged parcel will be calculated if the stated areas exist on the parcels being merged.

Syntax

Use dark colors for code blocksCopy
defaultAreaUnit=<area unit code>

attributeOverrides

(Required)

Introduced at 10.8.

A list of attributes that will be used to override and replace attributes on the new merged parcel.

Syntax

Use dark colors for code blocksCopy
attributeOverrides={"type":"PropertySet","propertySetItems":["<FieldName>",<value>,"<FieldName>",<value>,.....,"IsSeed",0]}

//If not overriding any attributes
attributeOverrides={"type":"PropertySet","propertySetItems":["isseed",0]}

async

(Optional)

Introduced at 11.1.

Specifies whether the request will be processed as an asynchronous job and a URL that points to a location displaying the status of the job will be returned. See the topic regarding asynchronous usage for more information. The default is false.

Values: true | false

Syntax

Use dark colors for code blocksCopy
async=true|false

f

The response format. The default response format is html.

Values: html | json

Example usage

This example shows the steps for merging parcels using the merge operation.

Start a service session on the version.

Request URL and parameters:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/rest/services/CountyFabric/VersionManagementServer/versions/E4DAED9D-C859-489B-9053-767A45F1D97C/startReading
f=json
sessionId={02DB3EE7-17D4-47B2-AFD1-F8EAFA22584E}

Start an edit session on the version.

Request URL and parameters:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/rest/services/CountyFabric/VersionManagementServer/versions/E4DAED9D-C859-489B-9053-767A45F1D97C/startEditing
f=json
sessionId={02DB3EE7-17D4-47B2-AFD1-F8EAFA22584E}

Merge two parcels into a single parcel. Override the Name, StatedArea, and StatedAreaUnit attributes.

Request URL and parameters:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/rest/services/CountyFabric/ParcelFabricServer/merge
f=json
gdbVersion=admin.Version1
sessionId={02DB3EE7-17D4-47B2-AFD1-F8EAFA22584E}
parentParcels=[{"id":"{A6486E07-47A6-44B6-AEC1-84581489E17C}","layerId":"28"},{"id":"{A8888BF3-4EC0-440C-92AF-DED78210F94C}","layerId":"28"}]
record={8CF6DC8D-41F4-4D75-93B5-87375BC8F9E3}
targetParcelType=28
defaultAreaUnit=109405
attributeOverrides={"type":"PropertySet","propertySetItems":["name","0713210004","statedarea",15440.6,"statedareaunit",109406,"isseed",0]}
async=false

If edits are complete, stop the edit session.
Stop and release the service session.

JSON Response syntax

The following response is returned when async is false:

Use dark colors for code blocksCopy
{
  "exceededTransferLimit: <true | false>,
  "moment": <datetime>,
  "error": {
    "extendedCode": <HRESULT>,
    "message": <error message>,
    "details": [<detail>]
  },
  "serviceEdits": {  // only if transfer limit is not exceeded
    "editedFeatures": {
      "updates": {
        "attributes": {},
        "geometry": {}
      },
      {
        "adds": {
          "attributes": {},
          "geometry": {}
        },
        {
          "deletes": {}
        },
        {
          "spatialReference": {<spatial reference>}
        },
        "id": <layerID>
      }
    },
    "success": <true | false>,
    "error": {  // only if success is false
      "extendedCode": <HRESULT>,
      "message": <error message>,
      "details": [<detail>]
    }
  }
}

The following response is returned when async is true:

Use dark colors for code blocksCopy
{
		"statusUrl": <url>
}