Copy lines to parcel type

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

Description

The copyLinesToParcelType operation copies the lines of the specified parcels to the specified parcel type and specified record. Use this operation to construct new parcels based on copied parent parcel lines. If the copied lines form closed loops, parcel seeds will automatically be created for the loops. Copied lines can be edited (insert, delete, and update) before building parcels.

Learn more about copying lines to a parcel type

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. A list of the parent parcels with the lines that will be copied. Syntax Use dark colors for code blocksCopy `1 parentParcels=[{"id":"<parcelguid>","layerId":"16"},{...}]`
`record` (Required)	Introduced at 10.8. The unique identifier (GUID) of the record. Copied lines will be associated with the specified record. Syntax Use dark colors for code blocksCopy `1 record=<guid>`
`markParentAsHistoric` (Required)	Introduced at 10.8. Specifies whether parent parcels will be retired as historic when lines are copied. Values: `true` \| `false` Syntax Use dark colors for code blocksCopy `1 markParentAsHistoric=<boolean>`
`useSourceLineAttributes` (Required)	Introduced at 10.8. Specifies whether the attributes of the original lines will be preserved and transferred to the copied lines. Values: `true` \| `false` Syntax Use dark colors for code blocksCopy `1 useSourceLineAttributes=<boolean>`
`useSourcePolygonAttributes` (Required)	Introduced at 10.8. Specifies whether the attributes of the parent parcels will be preserved and transferred to generated seeds. Values: `true` \| `false` Syntax Use dark colors for code blocksCopy `1 useSourcePolygonAttributes=<boolean>`
`targetParcelType` (Required)	Introduced at 10.8. The parcel type to which to copy the lines. Syntax Use dark colors for code blocksCopy `1 targetParcelType=<layer id>`
`targetParcelSubtype` (Optional)	Introduced at 10.8. The parcel subtype, if present, to which to copy the lines. Syntax Use dark colors for code blocksCopy `1 targetParcelSubtype=<subtype id>`
`attributeOverrides` (Required)	Introduced at 10.8. The attributes to override on the copied parcel lines. Copied attributes can be overriden with provided values. Syntax Use dark colors for code blocksCopy `1 attributeOverrides={"type":"PropertySet","propertySetItems":["<fieldname>",<value>, ...]}` When not overriding attributes, use the following syntax: Use dark colors for code blocksCopy `1 attributeOverrides={"type":"PropertySet","propertySetItems":[]}`
`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`	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>

parentParcels

(Required)

Introduced at 10.8.

A list of the parent parcels with the lines that will be copied.

Syntax

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

record

(Required)

Introduced at 10.8.

The unique identifier (GUID) of the record. Copied lines will be associated with the specified record.

Syntax

Use dark colors for code blocksCopy
record=<guid>

markParentAsHistoric

(Required)

Introduced at 10.8.

Specifies whether parent parcels will be retired as historic when lines are copied.

Values: true | false

Syntax

Use dark colors for code blocksCopy
markParentAsHistoric=<boolean>

useSourceLineAttributes

(Required)

Introduced at 10.8.

Specifies whether the attributes of the original lines will be preserved and transferred to the copied lines.

Values: true | false

Syntax

Use dark colors for code blocksCopy
useSourceLineAttributes=<boolean>

useSourcePolygonAttributes

(Required)

Introduced at 10.8.

Specifies whether the attributes of the parent parcels will be preserved and transferred to generated seeds.

Values: true | false

Syntax

Use dark colors for code blocksCopy
useSourcePolygonAttributes=<boolean>

targetParcelType

(Required)

Introduced at 10.8.

The parcel type to which to copy the lines.

Syntax

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

targetParcelSubtype

(Optional)

Introduced at 10.8.

The parcel subtype, if present, to which to copy the lines.

Syntax

Use dark colors for code blocksCopy
targetParcelSubtype=<subtype id>

attributeOverrides

(Required)

Introduced at 10.8.

The attributes to override on the copied parcel lines. Copied attributes can be overriden with provided values.

Syntax

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

When not overriding attributes, use the following syntax:

Use dark colors for code blocksCopy
attributeOverrides={"type":"PropertySet","propertySetItems":[]}

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

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

Values: html | json

Example usage

This example shows the steps for copying lines from a parcel in the tax parcel type to a specified record using the copyLinesToParcelType 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={0BD2FFC2-8B4D-4F3E-B497-0CD1E166D259}

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={0BD2FFC2-8B4D-4F3E-B497-0CD1E166D259}

Copy lines from the specified parcel to the specified parcel type and record. Do not change the parcel type and retire the original parcel as historic.

Request URL and parameters:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/rest/services/CountyFabric/ParcelFabricServer/copyLinesToParcelType
f=json
gdbVersion=admin.Version1
sessionId={0BD2FFC2-8B4D-4F3E-B497-0CD1E166D259}
parentParcels=[{"id":"{9887AFF5-1B86-42B4-8D2F-9CD45796362B}","layerId":"16"}]
record={67D9858E-B4D8-4C12-84C9-685EBA04B741}
markParentAsHistoric=true
useSourceLineAttributes=true
useSourcePolygonAttributes=true
targetParcelType=16
attributeOverrides={"type":"PropertySet","propertySetItems":[]}
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": {  // only if success is false
    "extendedCode": <HRESULT>,
    "message": <error message>,
    "details": [<detail>]
  },
  "serviceEdits": {  // only if transfer limit is not exceeded
    "editedFeatures": {
      "updates": {
        "attributes": {},
        "geometry": {}
      },
      {
        "adds": {
          "attributes": {},
          "geometry": {}
        },
        {
          "spatialReference": {<spatial reference>}
        }
      },
      "id": <layerID>}
    }
  },
  "success": <true | false>
}

The following response is returned when async is true:

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