Merge—REST APIs | Documentation for ArcGIS Enterprise

URL:https://<parcelfabricservice-url>/merge
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.

When merging parcels without an active record, parcel history will not be tracked and parcels won't be associated with the records that created or retired them.

Learn more about merging parcels

Request parameters


Parameter	Details
gdbVersion	The name of the geodatabase version (the default is the DEFAULT version). Syntax `gdbVersion=<version>`
sessionId	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 `sessionId=<guid>`
parentParcels	The parent parcels that will be merged. Syntax `parentParcels=[{"id":"<parcelguid>","layerId":"<layerID>"},{...}]`
record	The unique identifier (GUID) of the record that will be used for the merge. If no value is provided, the merged parcel will not be associated with any record and parcel lineage will not be tracked. Syntax `record=<guid>`
targetParcelType	The target parcel type (ID) in which the new, merged parcel will be created. Syntax `targetParcelType=<layer id>`
mergeInto (Optional)	One of the parent parcels into which the other parcels will be merged. Merging parcels into existing parcels will not create historic parcels and parcel lineage will not be tracked. Syntax `mergeInto=<parcelguid>`
defaultAreaUnit (Required)	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 `defaultAreaUnit=<area unit code>`
attributeOverrides (Required)	A list of attributes that will be used to override on the new merged parcel. Syntax `attributeOverrides={"type":"PropertySet","propertySetItems":["<FieldName>",<value>,"<FieldName>",<value>,.....,"IsSeed",0]} //If not overriding any attributes attributeOverrides={"type":"PropertySet","propertySetItems":["isseed",0]}`
async	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 `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.

Note:

The sessionId parameter value must be the same for starting the edit session, performing the edit operation, and stopping the edit session.

Start a service session on the version.

Request URL and parameters:


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:


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:


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:

{
  "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:

{
		"statusUrl": <url>
}

JSON Response example

The following is a response example when async is false:

JSON response:


{
  "moment": 1575586080140,
  "exceededTransferLimit": false,
  "serviceEdits": [
    {
      "id": 2,
      "editedFeatures": {
        "spatialReference": {
          "wkt": "PROJCS[\"NAD_1983_HARN_StatePlane_Illinois_East_FIPS_1201\",GEOGCS[\"GCS_North_American_1983_HARN\",DATUM[\"D_North_American_1983_HARN\",SPHEROID[\"GRS_1980\",6378137.0,298.257222101]],PRIMEM 
                 [\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Transverse_Mercator\"],PARAMETER[\"False_Easting\",984250.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian
                 \",-88.33333333333333],PARAMETER[\"Scale_Factor\",0.999975],PARAMETER[\"Latitude_Of_Origin\",36.66666666666666],UNIT[\"Foot_US\",0.3048006096012192]]",
          "xyTolerance": 0.00328083333333333,
          "zTolerance": 0.001,
          "mTolerance": 0.001,
          "falseX": -17463800,
          "falseY": -46132600,
          "xyUnits": 3048.00609601219,
          "falseZ": -100000,
          "zUnits": 10000,
          "falseM": -100000,
          "mUnits": 10000
        },
        "adds": []
      }
    },
    {
      "id": 28,
      "editedFeatures": {
        "spatialReference": {
          "wkt": "PROJCS[\"NAD_1983_HARN_StatePlane_Illinois_East_FIPS_1201\",GEOGCS[\"GCS_North_American_1983_HARN\",DATUM[\"D_North_American_1983_HARN\",SPHEROID[\"GRS_1980\",6378137.0,298.257222101]],PRIMEM
                 [\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Transverse_Mercator\"],PARAMETER[\"False_Easting\",984250.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian
                 \",-88.33333333333333],PARAMETER[\"Scale_Factor\",0.999975],PARAMETER[\"Latitude_Of_Origin\",36.66666666666666],UNIT[\"Foot_US\",0.3048006096012192]]",
          "xyTolerance": 0.00328083333333333,
          "zTolerance": 0.001,
          "mTolerance": 0.001,
          "falseX": -17463800,
          "falseY": -46132600,
          "xyUnits": 3048.00609601219,
          "falseZ": -100000,
          "zUnits": 10000,
          "falseM": -100000,
          "mUnits": 10000
        },
        "adds": [
          {
            "attributes": {
              "objectid": 13198,
              "name": "0713210004",
              "parcelsubtype": null,
              "createdbyrecord": "{8CF6DC8D-41F4-4D75-93B5-87375BC8F9E3}",
              "retiredbyrecord": null,
              "statedarea": 15440.6,
              "statedareaunit": 109406,
              "calculatedarea": 15462.56758152,
              "miscloseratio": 100000.0,
              "misclosedistance": 0.00000689,
              "isseed": 0,
              "created_user": "admin",
              "create_date": 1575586080000,
              "last_edited_user": "admin",
              "last_edited_date": 1575586080000,
              "globalid": "{7FB041BA-6E8F-4714-A0A2-E80F709AA0EA}",
              "Shape__Area": 15459.5705731841881,
              "Shape__Length": 504.023848263589514
            },
            "geometry": {
              "hasZ": true,
              "curveRings": [
                [
                  [1034017.39307076111, 1863042.5160689503, 0],
                  [1034014.49314218014, 1862988.60377519578, 0],
                  [1034011.85633642972, 1862939.59239028394, 0],
                  [1033856.43768401071, 1862941.69638869911, 0],
                  [1033861.46063984558, 1862990.51781336218, 0],
                  [1033864.3044661805, 1863021.32057327777, 0],
                    {
                      "c": [
                        [1033884.35167017952, 1863041.33201619983, 0],
                        [1033869.52466393064, 1863036.13828282245]
                      ]
                    },
                  [1034017.39307076111, 1863042.5160689503, 0]
                ]
              ]
            }
          }
        ],
        "updates": [
          {
            "attributes": {
              "objectid": 7724,
              "name": "0713210002",
              "parcelsubtype": null,
              "createdbyrecord": "{87628065-13EA-4D86-9132-EE806A6D1BA0}",
              "retiredbyrecord": null,
              "statedarea": 7551.855,
              "statedareaunit": null,
              "calculatedarea": null,
              "miscloseratio": 100000.0,
              "misclosedistance": 0.00000274,
              "isseed": 0,
              "created_user": "GIS",
              "create_date": 1573256350000,
              "last_edited_user": "GIS",
              "last_edited_date": 1573256350000,
              "globalid": "{A6486E07-47A6-44B6-AEC1-84581489E17C}",
              "Shape__Area": 7551.8550726693793,
              "Shape__Length": 406.638764581795215
            },
            "geometry": {
              "hasZ": true,
              "rings": [
                [
                  [1034011.85633642972, 1862939.59239028394, 0],
                  [1033856.43768401071, 1862941.69638869911, 0],
                  [1033861.46063984558, 1862990.51781336218, 0],
                  [1034014.49314218014, 1862988.60377519578, 0],
                  [1034011.85633642972, 1862939.59239028394, 0]
                ]
              ]
            }
          },
          {
            "attributes": {
              "objectid": 7724,
              "name": "0713210002",
              "parcelsubtype": null,
              "createdbyrecord": "{87628065-13EA-4D86-9132-EE806A6D1BA0}",
              "retiredbyrecord": "{8CF6DC8D-41F4-4D75-93B5-87375BC8F9E3}",
              "statedarea": 7551.855,
              "statedareaunit": null,
              "calculatedarea": null,
              "miscloseratio": 100000.0,
              "misclosedistance": 0.00000274,
              "isseed": 0,
              "created_user": "GIS",
              "create_date": 1573256350000,
              "last_edited_user": "admin",
              "last_edited_date": 1575586080000,
              "globalid": "{A6486E07-47A6-44B6-AEC1-84581489E17C}",
              "Shape__Area": 7551.8550726693793,
              "Shape__Length": 406.638764581795215
            },
            "geometry": {
              "hasZ": true,
              "rings": [
                [
                  [1034011.85633642972, 1862939.59239028394, 0],
                  [1033856.43768401071, 1862941.69638869911, 0],
                  [1033861.46063984558, 1862990.51781336218, 0],
                  [1034014.49314218014, 1862988.60377519578, 0],
                  [1034011.85633642972, 1862939.59239028394, 0]
                ]
              ]
            }
          }
        ]
      }
    },
    {
      "id": 27,
      "editedFeatures": {
        "spatialReference": {
          "wkt": "PROJCS[\"NAD_1983_HARN_StatePlane_Illinois_East_FIPS_1201\",GEOGCS[\"GCS_North_American_1983_HARN\",DATUM[\"D_North_American_1983_HARN\",SPHEROID[\"GRS_1980\",6378137.0,298.257222101]],PRIMEM
                 [\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Transverse_Mercator\"],PARAMETER[\"False_Easting\",984250.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian
                 \",-88.33333333333333],PARAMETER[\"Scale_Factor\",0.999975],PARAMETER[\"Latitude_Of_Origin\",36.66666666666666],UNIT[\"Foot_US\",0.3048006096012192]]",
          "xyTolerance": 0.00328083333333333,
          "zTolerance": 0.001,
          "mTolerance": 0.001,
          "falseX": -17463800,
          "falseY": -46132600,
          "xyUnits": 3048.00609601219,
          "falseZ": -100000,
          "zUnits": 10000,
          "falseM": -100000,
          "mUnits": 10000
        },
        "updates": [
          {
            "attributes": {
              "objectid": 36395,
              "createdbyrecord": "{87628065-13EA-4D86-9132-EE806A6D1BA0}",
              "retiredbyrecord": null,
              "parentlineid": null,
              "direction": 90.71658366,
              "distance": 153.05290794,
              "radius": null,
              "arclength": null,
              "radius2": null,
              "cogotype": null,
              "iscogoground": null,
              "cogoaccuracy": 6,
              "rotation": null,
              "scale": null,
              "created_user": "GIS",
              "create_date": 1573256411000,
              "last_edited_user": "GIS",
              "last_edited_date": 1573256411000,
              "globalid": "{EA099EB2-B882-46D8-8994-B3C84AC81945}",
              "Shape__Length": 153.044471682270057
            },
            "geometry": {
              "hasZ": true,
              "paths": [
                [
                  [1033861.46063984558, 1862990.51781336218, 0],
                  [1034014.49314218014, 1862988.60377519578, 0]
                ]
              ]
            }
          }
        ]
      }
    },
    {
      "id": 1,
      "editedFeatures": {
        "spatialReference": {
          "wkt": "PROJCS[\"NAD_1983_HARN_StatePlane_Illinois_East_FIPS_1201\",GEOGCS[\"GCS_North_American_1983_HARN\",DATUM[\"D_North_American_1983_HARN\",SPHEROID[\"GRS_1980\",6378137.0,298.257222101]],PRIMEM
                 [\"Greenwich\",0.0],UNIT[\"Degree\",0.0174532925199433]],PROJECTION[\"Transverse_Mercator\"],PARAMETER[\"False_Easting\",984250.0],PARAMETER[\"False_Northing\",0.0],PARAMETER[\"Central_Meridian
                 \",-88.33333333333333],PARAMETER[\"Scale_Factor\",0.999975],PARAMETER[\"Latitude_Of_Origin\",36.66666666666666],UNIT[\"Foot_US\",0.3048006096012192]]",
          "xyTolerance": 0.00328083333333333,
          "zTolerance": 0.001,
          "mTolerance": 0.001,
          "falseX": -17463800,
          "falseY": -46132600,
          "xyUnits": 3048.00609601219,
          "falseZ": -100000,
          "zUnits": 10000,
          "falseM": -100000,
          "mUnits": 10000
        },
        "updates": [
          {
            "attributes": {
              "objectid": 799,
              "name": "Rec001",
              "recordtype": null,
              "recordeddate": null,
              "cogoaccuracy": null,
              "created_user": "admin",
              "create_date": 1575571055000,
              "last_edited_user": "admin",
              "last_edited_date": 1575571055000,
              "parcelcount": null,
              "globalid": "{8CF6DC8D-41F4-4D75-93B5-87375BC8F9E3}"
            },
            "geometry": {
              "hasZ": true,
              "rings": []
            }
          },
          {
            "attributes": {
              "objectid": 799,
              "name": "Rec001",
              "recordtype": null,
              "recordeddate": null,
              "cogoaccuracy": null,
              "created_user": "admin",
              "create_date": 1575571055000,
              "last_edited_user": "admin",
              "last_edited_date": 1575586080000,
              "parcelcount": 1
            },
            "geometry": {
              "hasZ": true,
              "curveRings": [
                [
                  [1034017.39307076111, 1863042.5160689503, 0],
                  [1034014.49314218014, 1862988.60377519578, 0],
                  [1034011.85633642972, 1862939.59239028394, 0],
                  [1033856.43768401071, 1862941.69638869911, 0],
                  [1033861.46063984558, 1862990.51781336218, 0],
                  [1033864.3044661805, 1863021.32057327777, 0],
                    {
                      "c": [
                        [1033884.35167017952, 1863041.33201619983, 0],
                        [1033869.52466393064, 1863036.13828282245]
                      ]
                    },
                  [1034017.39307076111, 1863042.5160689503, 0]
                ]
              ]
            }
          }
        ]
      }
    }
  ],
  "success": true
}

Feedback on this topic?

Description

Request parameters

Example usage

Note:

JSON Response syntax

JSON Response example

In this topic