Update parcel history

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

Description

The updateParcelHistory operation sets the specified parcel features to current or historic using the specified record. When setting current parcels as historic, the Retired By Record field of the features is updated with the global ID of the specified record. When setting historic parcels as current, the Created By Record field of the features is updated with the global ID of the specified record.

Learn more about setting parcel history

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>`
`parcelFeatures` (Required)	Introduced at 10.8. The parcel features that will be set as historic or current. The features can be parcels, parcel polygons, parcel points, and parcel lines. Syntax Use dark colors for code blocksCopy `1 parcelFeatures=[{"id":"<guid>","layerId":"<layerID>"},{...}]`
`setAsHistoric` (Required)	Introduced at 10.8. Specifies whether the features will be set as historic (`true`) or current (`false`). Syntax Use dark colors for code blocksCopy `1 setAsHistoric=<Boolean>`
`record` (Required)	Introduced at 10.8. The unique identifier (GUID) of the record that will be assigned to the features set as current or historic. Syntax Use dark colors for code blocksCopy `1 record=<guid>`
`async` (Optional)	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`	Specifies the output format of the response. 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>

parcelFeatures

(Required)

Introduced at 10.8.

The parcel features that will be set as historic or current. The features can be parcels, parcel polygons, parcel points, and parcel lines.

Syntax

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

setAsHistoric

(Required)

Introduced at 10.8.

Specifies whether the features will be set as historic (true) or current (false).

Syntax

Use dark colors for code blocksCopy
setAsHistoric=<Boolean>

record

(Required)

Introduced at 10.8.

The unique identifier (GUID) of the record that will be assigned to the features set as current or historic.

Syntax

Use dark colors for code blocksCopy
record=<guid>

async

(Optional)

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

Specifies the output format of the response. The default response format is html.

Values: html | json

Example usage

This example shows the steps for setting a parcel as historic using the updateParcelHistory 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={f24783f6-1e2a-47d6-9505-1b36898d632a}

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={f24783f6-1e2a-47d6-9505-1b36898d632a}

Set a parcel as historic using the specified record.

Request URL and parameters:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/rest/services/CountyFabric/ParcelFabricServer/updateParcelHistory
f=json
gdbVersion=admin.Version1
sessionId={f24783f6-1e2a-47d6-9505-1b36898d632a}
parcelFeatures=[{"id":"{E60840C7-8A91-45BD-85C8-9DDF00BF2C82}","layerId":"13"}]
setAsHistoric=true
record={C379E2BB-7F9E-4593-B760-D4E908F8445D}
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
{
  "moment": <datetime>,
  "exceededTransferLimit: <true | false>,
  "serviceEdits": [  // only if transfer limit is not exceeded
    {
      "id": <layerID>,
      "editedFeatures": {
        "spatialReference": {<spatialreference>},
        "adds": [
          {
            "attributes": {},
            "geometry": {}
          }
        ]
      }
    },
    {
      "id": <layerID>,
      "editedFeatures": {
        "spatialReference": {<spatialreference>},
        "updates": [
          {
            "attributes": {},
            "geometry": {}
          }
        ]
      }
    }
  ],
  "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>
}