Manager class for manipulating feature layer attachments.

This class can be created by the user directly if a version is to be specified.

Otherwise, an instance of this class, called ‘attachments’,is available as a property of the FeatureLayer object, if the layer supports attachments.Users call methods on this ‘attachments’ object to manipulate (create, get, list, delete) attachments.

add(oid:str,file_path:str,keywords:str|None=None,return_moment:bool=False)→bool

Adds an attachment to aFeatureLayer. Adding an attachmentis a feature update, but is support with either the Update or the Create capability.The add operation is performed on a feature service feature resource.

Parameter	Description
oid	Required string of the object ID.
file_path	Required string. Path to the file to be uploaded as a new featureattachment. The content type, size, and name of the attachment willbe derived from the uploaded file.
keywords	Optional string. Sets a text value that is stored as the keywordsvalue for the attachment. This parameter can be set when the layer hasan attachmentProperties property that includes “name”: “keywords”with “isEnabled”: True. If the attachments have keywords enabledand the layer also includes the attachmentFields property,you can use it to understand properties like keywords field length.
return_moment	Optional bool. Specify whether the response will report the timeattachments were added. If True, the server will return the timein the response’seditMoment key. The default is False.

Returns:

A JSON Response stating ‘success’ or ‘error’

count(where:str|None=None,attachment_where:str|None=None,object_ids:str|None=None,global_ids:str|None=None,attachment_types:str|None=None,size:tuple[int]|list[int]|None=None,keywords:str|None=None)→int

The count operation returns the total number of attachments that satisfythe specific criteria entered as arguments to the method. The defaultcount is the number of attachments for all features in the layer.

Parameters	Description
where	Optional String. Clause to specify the set of featuresfor which to return the attachment count.
attachment_where	Optional String. Clause to specify criteria to apply tothe attachments table for which specific attachments toinclude in the count value.
object_ids	Optional List. List ofobject_id values to be queriedfor which to count the number of attachments.
global_ids	Optional List. List ofglobal_id values to be queriedfor which to count the number of attachments.
attachment_types	Optional String. Value specifying the specific formatof attachments to count. SeeattachmentTypes attheQuery Attachmentspage for a list of options to use.
size	Optional Integer or integer range. Value or values toto query attachments of a specific size.

Returns:

Integer of total number of attachments.

# Usage Example 1: Default>>>fromarcgis.gisimportGIS>>>gis=GIS(profile="your_organizational_profile")>>>flyr_item=gis.content.get("<item id>")>>>att_mgr=flyr_item.attachments>>>att_mgr.count()9# Usage Example 2: List of Object Ids:>>>att_mgr.count(object_ids=[1,3])5# Usage Example 3: List of Global Ids:>>>att_mgr.count(global_ids=['{D432BA85-8702-437D-B740-C214DDE65846}'])2

delete(oid:str,attachment_id:str,return_moment:bool=False,rollback_on_failure:bool=True)→bool

Removes an attachment from aFeatureLayer . Deleting an attachment is a feature update;it requires the Update capability. The deleteAttachments operation is performed on afeature service feature resource. This operation is available only if the layer has advertised that it has attachments.A layer has attachments if its hasAttachments property is true.

Parameter	Description
oid	Required string of the object ID
attachment_id	Required string. Ids of attachment to delete. Syntax: attachment_id = “<attachmentId1>, <attachmentId2>”
return_moment	Optional boolean. Specify whether the response will report the timeattachments were deleted. If True, the server will report the timein the response’seditMoment key. The default value is False.
rollback_on_failure	Optional boolean. Specifies whether the edits should be appliedonly if all submitted edits succeed. If False, the server will applythe edits that succeed even if some of the submitted edits fail.If True, the server will apply the edits only if all edits succeed.The default value is true.

Result:

JSON response stating ‘success’ or ‘error’

download(oid:str|None=None,attachment_id:str|None=None,save_path:str|None=None)

Downloads attachment and returns its path on disk.

The download tool works as follows:

• If nothing is given, all attachments will be downloaded

  Example: download()

• If a single oid and attachment_id are given, the single file will download

• If a list of oid values are given, all the attachments for those object ids will be saved locally.

Argument	Description
oid	Optional list/string. A list of object Ids or a single valueto download data from.
attachment_id	Optional string. Id of the attachment to download. This is onlyhonored if return_all is False.
save_path	Optional string. Path to save data to.

Returns:

A path to the folder where the attachement are saved

get_list(oid:str)

Get the list of attachments for a given OBJECT ID

Parameter	Description
oid	Required string of the object id

Result:

A list of attachments

search(where:str='1=1',object_ids:str|None=None,global_ids:str|None=None,attachment_types:str|None=None,size:tuple[int]|list[int]|None=None,keywords:str|None=None,show_images:bool=False,as_df:bool=False,return_metadata:bool=False,return_url:bool=False,max_records:int|None=None,offset:int|None=None,*,attachment_where:str|None=None)

Thesearch method allows querying the layer for its attachments and returns the results asa Pandas DataFrame or dict

Parameter	Description
where	Required string. The definition expression to be applied tothe related layer/table. From the list of records that arerelated to the specified object Ids, only those records thatconform to this expression will be returned. Example: where=”STATE_NAME = ‘Alaska’”. The query results will return all attachments in Alaska.
object_ids	Optional list/string. The object IDs of this layer/table to bequeried. Syntax: object_ids = <object_id1>, <object_id2> Example: object_ids = 2 The query results will return attachments only for the specified object id.
global_ids	Optional list/string. The global IDs of this layer/table to bequeried. Syntax: global_ids = <globalIds1>,<globalIds2> Example: global_ids = 6s430c5a-kb75-4d52-a0db-b30bg060f0b9, 35f0d027-8fc0-4905-a2f6-373c9600d017 The query results will return attachments only for specifiedglobal id.
attachment_types	Optional list/string. The file format that is supported byquery attachment. Supported attachment types:bmp, ecw, emf, eps, ps, gif, img, jp2, jpc, j2k, jpf, jpg,jpeg, jpe, png, psd, raw, sid, tif, tiff, wmf, wps, avi, mpg,mpe, mpeg, mov, wmv, aif, mid, rmi, mp2, mp3, mp4, pma, mpv2,qt, ra, ram, wav, wma, doc, docx, dot, xls, xlsx, xlt, pdf, ppt,pptx, txt, zip, 7z, gz, gtar, tar, tgz, vrml, gml, json, xml,mdb, geodatabase Example: attachment_types=’image/jpeg’
size	Optional tuple/list. The file size of the attachment isspecified in bytes. You can enter a file size range(1000,15000) to query for attachments with the specified range. Example: size= (1000,15000) The query results will return all attachments within thespecified file size range (1000 - 15000) bytes.
keywords	Optional string. When attachments are uploaded, keywords canbe assigned to the uploaded file. By passing a keyword value,the values will be searched. Example: keywords=’airplanes’
show_images	Optional bool. The default is False, when the value is True,the results will be displayed as a HTML table. If the as_df isset to False, this parameter will be ignored.
as_df	Optional bool. Default is False, if True, the results will bea Pandas’ DataFrame. If False, the values will be a list ofdictionary values.
return_metadata	Optional Boolean. If true, metadata stored in theexifInfocolumn will be returned for attachments that haveexifInfo.This option is supported only when “name”: “exifInfo” in thelayer’s attachmentProperties includes “isEnabled”: true. Whenset to false, or not set, None is returned forexifInfo.
return_url	Optional Boolean. Specifies whether to return the attachmentURL. The default is false. This parameter is supported if thesupportsQueryAttachmentsWithReturnUrl property is true on thelayer. Applications can use this URL to download the attachmentimage.
max_records	Optional Integer. This option fetches query results up to theresultRecordCount specified. WhenresultOffset is specifiedand this parameter is not, the feature service defaults to themaxRecordCount. The maximum value for this parameter is thevalue of the layer’smaxRecordCount property. This parameteronly applies ifsupportPagination is true.
offset	Optional Integer. This parameter is designed to be used inconjunction withmax_records to page through a long list ofattachments, one request at a time. This option fetches queryresults by skipping a specified number of records. The queryresults start from the next record (i.e., resultOffset + 1).The default value is 0. This parameter only applies whensupportPagination is true. You can use this option to fetchrecords that are beyondmaxRecordCount property.
attachment_where	Optional str. The definition expression to be applied to theattachments table. Only those records that conform to thisexpression will be returned. You can get the attachments tablefield names to use in the expression by checking the layer’sattachmentProperties.

Returns:

A Pandas DataFrame or Dict of the attachments of theFeatureLayer

update(oid:str,attachment_id:str,file_path:str,return_moment:bool=False)→bool

Updates an existing attachment with a new file

Parameter	Description
oid	Required string of the object ID.
attachment_id	Required string. Id of the attachment to update.
file_path	Required string. Path to file to be uploaded as the updated featureattachment.
return_moment	Optional boolean. Specify whether the response will report the timeattachments were deleted. If True, the server will report the timein the response’seditMoment key. The default value is False.

Result:

JSON response stating ‘success’ or ‘error’

Manager class for manipulating replicas for syncing disconnected editing ofFeatureLayer .This class is not created by users directly.An instance of this class, called ‘replicas’, is available as a property of theFeatureLayerCollection object,if the layer is sync enabled / supports disconnected editing.Users call methods on this ‘replicas’ object to manipulate (create, synchronize, unregister) replicas.

cleanup_change_tracking(layers:list[int],retention_period:int,period_unit:str='days',min_server_gen:str|None=None,replica_id:str|None=None,future:bool=False)

Change tracking information stored in each feature service layer(enabled for Change Tracking) might grow very large. The changetracking info used by the feature service to determine the changegeneration number and the features that have changed for aparticular generation. Clients can purge the change trackingcontent if the changes are already synced-up to all clients and thechanges are no longer needed.

Only the owner or the organization administrator can cleanup changetracking information.

Parameter	Description
layers	Required list. A list of layers and tables to include in the replica.
retention_period	Optional Integer. The retention period to use when cleaning up thechange tracking information. Change tracking information will becleaned up if they are older than the retention period.
period_unit	Optional String. The units of the retention period. Values: days,seconds,minutes, orhours
min_server_gen	Optional String. In addition to the retention period, the changetracking can be cleaned by its generation numbers. Older trackinginformation that has older generation number than themin_server_gen will be cleaned.
replica_id	Optional String. The change tracking can also be cleaned by thereplica_id in addition to theretention_period and themin_server_gen.
future	Optional boolean. If True, a future object will be returned and the processwill not wait for the task to complete. The default is False, which means wait for results.

Returns:

Boolean or Iffuture=True, then the result is aFuture object. Callresult() to get the response.

create(replica_name:str,layers:list[int],layer_queries:dict[str,Any]|None=None,geometry_filter:dict[str,str]|None=None,replica_sr:dict[str,Any]|int|None=None,transport_type:str='esriTransportTypeUrl',return_attachments:bool=False,return_attachments_databy_url:bool=False,asynchronous:bool=False,attachments_sync_direction:str='none',sync_model:str='none',data_format:str='json',replica_options:dict[str,Any]|None=None,wait:bool=False,out_path:str|None=None,sync_direction:str|None=None,target_type:str='client',transformations:list[str]|None=None,time_reference_unknown_client:bool|None=None)

The create operation is performed on aFeatureLayerCollection resource. Thisoperation creates a replica on the server between the feature serviceand the client based on replica definition criteria supplied by theclient.

The feature service must have theSync capability. Seepublishing criteriafor details on how to publish services and set capabilities.TheSync overviewprovides additional details and links for details.

The response to this method includes thereplicaID,replicageneration number, and data similar to the response from thequery() operation ona service. This information should be kept track of by the client becauseit will be needed when synchronizing changes in the local data with thereplica created on the server.

SeeSync response typesdetails on the response received.

The operations allows for register exiting data for the replica byusing thereplica_options argument, a dictionary whose key-value pairs aredetailedhere.

For full details seeCreate Replica.

Parameter	Description
replica_name	Required string. Name of the replica.
layers	Required list. A list of layers and tables to include in the replica.
layer_queries	Optional dictionary. In addition to the layers and geometryparameters, the layer_queries parameter can be used to further definewhat is replicated. This parameter allows you to set properties on aper layer or per table basis. Only the properties for the layers andtables that you want changed from the default are required. Example: layer_queries = {“0”:{“queryOption”: “useFilter”, “useGeometry”: true, “where”: “requires_inspection = Yes”}}
geometry_filter	Optional dictionary. Spatial filter fromfilters moduleto filter results by a spatial relationship with another geometry.
replica_sr	Optional WKID or a spatial reference JSON object. The spatialreference of the replica geometry.
transport_type	The transport_type represents the response format. If thetransport_type is esriTransportTypeUrl, the JSON response is containedin a file, and the URL link to the file is returned. Otherwise, theJSON object is returned directly. The default is esriTransportTypeUrl.If async is true, the results will always be returned as iftransport_type is esriTransportTypeUrl. If dataFormat is sqlite, thetransportFormat will always be esriTransportTypeUrl regardless of howthe parameter is set. Values: esriTransportTypeUrl | esriTransportTypeEmbedded.
return_attachments	If True, attachments are added to the replica and returned in theresponse. Otherwise, attachments are not included. The default isFalse. This parameter is only applicable if the feature service hasattachments.
return_attachments_databy_url	If True, a reference to a URL will be provided for each attachmentreturned from create method. Otherwise, attachments are embedded inthe response. The default is True. This parameter is only applicableif the feature service has attachments and if return_attachments isTrue.
asynchronous	If True, the request is processed as an asynchronous job, and a URLis returned that a client can visit to check the status of the job.See the topic on asynchronous usage for more information. The defaultis False.
attachments_sync_direction	Client can specify the attachmentsSyncDirection when creating areplica. AttachmentsSyncDirection is currently a createReplica propertyand cannot be overridden during sync. Values: none, upload, bidirectional
sync_model	This parameter is used to indicate that the replica is being createdfor per-layer sync or per-replica sync. To determine which model typesare supported by a service, query the supportsPerReplicaSync,supportsPerLayerSync, and supportsSyncModelNone properties of the FeatureService. By default, a replica is created for per-replica sync.If syncModel is perReplica, the syncDirection specified during syncapplies to all layers in the replica. If the syncModel is perLayer, thesyncDirection is defined on a layer-by-layer basis. If sync_model is perReplica, the response will have replicaServerGen.A perReplica sync_model requires the replicaServerGen on sync. ThereplicaServerGen tells the server the point in time from which to sendback changes. If sync_model is perLayer, the response will include anarray of server generation numbers for the layers in layerServerGens. AperLayer sync model requires the layerServerGens on sync. ThelayerServerGens tell the server the point in time from which to sendback changes for a specific layer. sync_model=none can be used to exportthe data without creating a replica. Query the supportsSyncModelNoneproperty of the feature service to see if this model type is supported. See theRollbackOnFailure and Sync Models topic for more details. Values: perReplica | perLayer | none Example: sync_model = perLayer
data_format	The format of the replica geodatabase returned in the response. Thedefault is json. Values: filegdb, json, sqlite, shapefile
replica_options	This parameter instructs the create operation to create a new replicabased on an existing replica definition (refReplicaId). It can be usedto specify parameters for registration of existing data for sync. Theoperation will create a replica but will not return data. TheresponseType returned in the create response will beesriReplicaResponseTypeInfo.
wait	If async, wait to pause the process until the async operation is completed.
out_path	out_path - folder path to save the file.
sync_direction	Defaults to bidirectional when the targetType is client and downloadwhen the target_type is server. If set, only bidirectional is supportedwhen target_type is client. If set, only upload or download aresupported when target_type is server. Values: download | upload | bidirectional Example: sync_direction=download
target_type	Can be set to either server or client. If not set, the default isclient. This option was added at 10.5.1.
transformations	Optional List. Introduced at 10.8. This parameter applies a datumtransformation on each layer when the spatial reference used ingeometry is different from the layer’s spatial reference.
time_reference_unknown_client	Setting time_reference_unknown_client as true indicates that the client iscapable of working with data values that are not in UTC. If its not setto true, and the service layer’s datesInUnknownTimeZone property is true,then an error is returned. The default is false It’s 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 returnedas-is from the database, rather than as date values in UTC. Non-hosted featureservices can be set to use an unknown time zone using ArcGIS Server Manager.Setting the time zones to unknown also sets the datesInUnknownTimeZone layer propertyas true. Currently, hosted feature services do not support this setting.This setting does not apply to editor tracking date fields which arestored 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 ableto work with feature services that have an unknown time setting.The timeReferenceUnknownClient parameter prevents these clients from workingwith the service in order to avoid problems..Setting this parameter to true indicates that the client is capable of working withunknown date values that are not in UTC.

Returns:

JSON response if POST request made successfully. Otherwise, return None.

create_replica_item(replica_name:str,item:Item,destination_gis:GIS,layers:list[int]|None=None,extent:dict[str,Any]|None=None)

Creates a replicated service from a parent to another GIS.

Parameter	Description
replica_name	Optional string. Name for replicated item in other GIS
item	Required Item to replicate
destination_gis	RequiredGIS object
layers	Optional list. Layers to replicate in the item
extent	Optional dict. Depicts the geometry extent for an item.

Returns:

The published replica item created

get(replica_id:str)

Parameter	Description
replica_id	Required string. replica_id returned by the feature service whenthe replica was created.

Returns:

The replica information

get_list()

returns all the replicas for the feature layer collection

sync_replicated_items(parent:Item,child:Item,replica_name:str)

Synchronizes two replicated items between portals

Parameter	Description
parent	RequiredItem that points to the feature servicethat is the parent dataset. (source)
child	RequiredItem that points to the feature servicethat is the child dataset. (target)
replica_name	Required string. Name of either parent or child Item

Result:

Boolean value. True means service is up to date/synchronized,False means the synchronization failed.

synchronize(replica_id:str,transport_type:str='esriTransportTypeUrl',replica_server_gen:int|None=None,return_ids_for_adds:bool=False,edits:list[dict[str,Any]]|None=None,return_attachment_databy_url:bool=False,asynchronous:bool=False,sync_direction:str='snapshot',sync_layers:str='perReplica',edits_upload_id:dict|None=None,edits_upload_format:str|None=None,data_format:str='json',rollback_on_failure:bool=False)

The synchronize operation synchronizes data between a local copy of datacreated by a client and a feature service based on areplica_id valueobtained when creating the replica. SeeSync overviewfor more information on the process.

The client obtains thereplica_id by first calling thecreate() operation. Synchronizeapplies the client’s data changes by importing them onto the server. Itthen exports the changes from the server that have taken place since thelast time the client retrieved the server’s data. Edits can be suppliedin theedits parameter or by using theedits_uploads_id andedits_upload_format arguments to identify a file item containing theedits that were previously uploaded using theupload() method.

The response for this operation includes areplicaID value, newreplica generation number, or layer’s generation numbers. The responsehas edits or layers according to thesync_direction/sync_layersarguments. Presence of layers and edits in the response is indicated by theresponseTypekey.

If theresponseType value isesriReplicaResponseTypeEdits oresriReplicaResponseTypeEditsAndData, the result of this operation caninclude lists of edit results for each layer/table edited. Each editresult identifies a single feature in a layer or row in a table andindicates if the edits were successful or not. If an edit is notsuccessful, the edit result also includes an error code and an errordescription.

• Ifsync_model isperReplica andsync_direction is download orbidirectional, thesynchronize()operation’s response will have edits.

• Ifsync_direction issnapshot, the response will have replacement data.

• Ifsync_model isperLayer, andsync_layers havesync_directionas download or bidirectional, the response will have edits.

• Ifsync_layers havesync_direction as download or bidirectionalfor some layers and snapshot for other layers, the response will have editsand data.

• Ifsync_direction for all the layers is snapshot, the response willhave replacement data.

• Ifsync_model isperReplica, thecreate()andsynchronize() responsescontainreplicaServerGen values.

• Ifsync_model isperLayer, thecreate()andsynchronize() responses containlayerServerGens values.

SeeSynchronize Replicafor full details on the operation.

Parameter	Description
replica_id	Required string. The ID of the replica you want to synchronize.
transport_type	Optional String. Represents the format of the response. The defaultvalue isesriTransportTypeUrl. Values: esriTransportTypeUrl - the response is contained in a file and athe URL link to the file is returned esriTransportTypeEmbedded - a JSON object is returned in theresponse Note Ifasynchronous isTrue ordata_format=sqllite, theresponse is always returned by URL.
replica_server_gen	Required Integer. A generation number that allows the server to keeptrack of what changes have already been synchronized.A newreplicaServerGen is sent with the response. Clients shouldpersist this value and use it with the next call tosynchronize. Note Applies whensync_model isperReplica
return_ids_for_adds	Optional Boolean. IfTrue, theobjectIDs andglobalIDs offeatures added during the synchronize will be returned to the clientin theaddResults sections of the response. Otherwise, the IDs arenot returned. The default isFalse.
edits	Optional list of dictionaries. Contains The edits the client wantsto apply to the service. Note This argument can be omitted if theedits_upload_id andedits_upload_format arguments are provided instead. The edits are provided as a list where each element is a dictionarywhose key-value pairs provide: id - The layer or table ID features - a dictionary of inserts, updates, and deletes. Newfeatures and updates are provided as lists offeatures.Deletes are provided as lists ofglobalIDs. attachments - a dictionary of inserts, updates, and deletes. Deletescan be specified as a list ofglobalIDs. Updates and adds arespecified using the following set of properties: 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 attachmentis embedded. url - The location where the service will upload the attachment file (for example,http://machinename/arcgisuploads/Hydrant.jpg). Only required if the attachment is notembedded. Note If embedding the attachment, set thedata property, otherwise seturl. Seeeditsfor full details on formatting.
return_attachment_databy_url	IfTrue, a reference to a URL will be provided for each attachmentreturned. Otherwise, attachments are embedded in the response. Thedefault isTrue. Note Only applies if attachments are included in the replica.
asynchronous	IfTrue, the request is processed as an asynchronous job and a URLis returned that a client can visit and check the status. See theasynchronous operationsfor more information. The default is False.
sync_direction	Optional String. Determines whether to upload, download, or uploadand download. By default, a replica is synchronized bi-directionally.Only applicable whensync_model isperReplica. Ifsync_modelisperLayer, thesync_layers argument contains this information. Values: download - The changes that have taken place on the server since last download arereturned. Client does not need to send any changes. If the changes are sent, servicewill ignore them. upload - The changes submitted in the edits or editsUploadID/editsUploadFormatparameters are applied, and no changes are downloaded from the server. bidirectional - The changes submitted in the edits or editsUploadID/editsUploadFormatparameters are applied, and changes on the server are downloaded. This is the defaultvalue. snapshot - The current state of the features is downloaded from the server. If any editsare specified, they will be ignored.
sync_layers	Required List of dictionaries specifying layer level criteria for theoperation ifsync_model isperLayer. The information in thedictionary allows a client to specify layer level generation numbers,and can also be used to specify individual directions forsynchronization per layer. Syntax: >>>flc.replicas.synchronize(... sync_layers = [ { "id": <layer id>, "serverGen": <generation number1>, "serverSibGen": <sib generation number>, "syncDirection": "<sync_direction1>" }, ... ] ... ) Note This parameter is ignored whensync_model isperReplica IfsyncDirection value isbidirectional ordownload,serverGen is required TheserverSibGen is only needed when syncing for replicas wherethetarget_type argument wasserver when created For replicas where thesyncModel value isperLayer, theserverSibGenserves the purpose of keeping track of changes already received at thelayer level the same wayreplicaServerGen does at the replica level.It is updated when a synchronization completes. If this argument is provided andsync_direction is provided, layersin this argument that do not provide asyncDirection value will usethe value ofsync_direction. Ifsync_direction is not specified,the defaultbidirectional is used.
edits_upload_id	Optional String. The ID for the uploaded item that contains the editsthe client wants to apply to the service. Used in conjunction withedits_upload_format. Note This is theid value returned when the edits were addedto the service resources usingupload().
edits_upload_format	Optional String. The data format of the data referenced inedit_upload_id.
data_format	Optional String. The format for the data returned in the response.The default value isjson. Values: json - data is embedded in the response sqlite - a mobile geodatabase is returned which can be used inArcGIS runtime applications
rollback_on_failure	Optional Boolean. Determines the behavior when there are errorswhile importing edits on the server during the operation. This onlyapplies whensync_direction isupload orbidirectional, orthesyncDirection key of an individualsync_layers element isupload orbidirectional. See theRollback On Failure andSync Modeldocumentation for full details. WhenTrue, if an error occurs while importing edits on theserver, all edits are rolled back and not applied. Theoperation returns an error in the response. Use this settingwhen the edits are such that you will either want all or noneapplied. WhenFalse, if an error occurs while importing an edit on theserver, the operation skips the edit and continues.that were skipped are returned in the edits results withinformation describing why the edits were skipped. This is thedefault value.
close_replica	Optional Boolean. Indicates whether to unregister the replicaupon completion. The default value isFalse. IfTrue, the replica will be unregistered when operationcompletes. IfFalse, the replica can continue to be synchronized.
out_path	optional String. Path of a folder to save the output to a file.

Returns:

A Python dictionary with various keys depending upon inputs.

unregister(replica_id:str)

Unregister a replica from a feature layer collection

Parameter	Description
replica_id	The replicaID returned by the feature service when the replica was created.

Allows updating the definition (if access permits) of aFeatureLayerCollection.This class is not created by users directly.An instance of this class, called ‘manager’, is available as a property of theFeatureLayerCollection object.

Users call methods on this ‘manager’ object to manage the feature layer collection.

add_to_definition(json_dict:dict[str,Any],future:bool=False)

The add_to_definition operation supports adding a definitionproperty to a hosted feature layer collection service. The result of thisoperation is a response indicating success or failure with errorcode and description.

This function will allow users to change or add additional valuesto an already published service.

Parameter	Description
json_dict	Required dict. The part to add to the hosted service. The formatcan be derived from theproperties property.For layer level modifications, run updates on each individual featureservice layer object. Find more information on what this dictionary can contain at:https://developers.arcgis.com/rest/services-reference/enterprise/feature-service/#json-response-syntax
future	Optional, If True, a future object will be returns and the processwill not wait for the task to complete.The default is False, which means wait for results.

Returns:

JSON message as dictionary whenfuture=False else Iffuture=True,then the result is aFuture object. Callresult() to get the response.

create_view(name:str,spatial_reference:dict[str,Any]|None=None,extent:dict[str,int]|None=None,allow_schema_changes:bool=True,updateable:bool=True,capabilities:str='Query',view_layers:list[int]|None=None,view_tables:list[int]|None=None,*,description:str|None=None,tags:str|None=None,snippet:str|None=None,overwrite:bool|None=None,set_item_id:str|None=None,preserve_layer_ids:bool=True,visible_fields:list[str]|None=None,query:str|None=None,folder:Folder|str|None=None)

Creates a view of an existing feature service. You can create a view, if you need a different view of the datarepresented by a hosted feature layer, for example, you want to apply different editor settings, apply differentstyles or filters, define which features or fields are available, or share the data to different groups thanthe hosted feature layer create a hosted feature layer view of that hosted feature layer.

When you create a feature layer view, a new hosted feature layer item is added to Content. This new layer is aview of the data in the hosted feature layer, which means updates made to the data appear in the hosted featurelayer and all of its hosted feature layer views. However, since the view is a separate layer, you can changeproperties and settings on this item separately from the hosted feature layer from which it is created.

For example, you can allow members of your organization to edit the hosted feature layer but share a read-onlyfeature layer view with the public.

To learn more about views visit:https://doc.arcgis.com/en/arcgis-online/share-maps/create-hosted-views.htm

Parameter	Description
name	Required string. Name of the new view item
spatial_reference	Optional dict. Specify the spatial reference of the view
extent	Optional dict. Specify the extent of the view
allow_schema_changes	Optional bool. Default is True. Determines if a view can alter aservice’s schema.
updateable	Optional bool. Default is True. Determines if view can update values
capabilities	Optional string. Specify capabilities as a comma separated string.For example “Query, Update, Delete”. Default is ‘Query’.
view_layers	Optional list. Specify list of layers present in the FeatureLayerCollectionthat you want in the view.
view_tables	Optional list. Specify list of tables present in the FeatureLayerCollectionthat you want in the view.
description	Optional String. A user-friendly description for the published dataset.
tags	Optional String. The comma separated string of descriptive words.
snippet	Optional String. A short description of the view item.
overwrite	Not supported. Note To overwrite the data used in a hosted feature layer view, youmust overwrite the hosted feature layer from which it wascreated. See theArcGIS Online Overwrite hosted feature layersor theArcGIS Enterprise Overwrite hosted feature layersdocumentation for requirements and considerations foroverwriting. See alsoConsiderations when creating hosted feature layer viewsfor additional criteria for overwriting.
set_item_id	Optional String. If set, the item id is defined by the user ratherthan the system. The parameter requiresArcGIS Enterprise 11.1 or higher. Note This parameter is not available for ArcGIS Online.
preserve_layer_ids	Optional Boolean. Preserves the layer’sid on it’s definition whenTrue. The default isTrue.
visible_fields	Optional list[str] or None. A list of visible fields to display.
query	Optional String. A SQL statement that defines the view.
folder	Optional string or Folder. The folder to which the view will be saved.

Returns:

Returns the newly createdItem for the view.

delete_from_definition(json_dict:dict[str,Any],future:bool=False)

The delete_from_definition operation supports deleting adefinition property from a hosted feature layer collection service. The result ofthis operation is a response indicating success or failure witherror code and description.SeeDelete From Definition (Feature Service)for additional information on this function.

Parameter	Description
json_dict	Required dict. The part to add to the hosted service. The formatcan be derived from theproperties property.For layer level modifications, run updates on each individual featureservice layer object.
future	Optional boolean. If True, a future object will be returns and the processwill not wait for the task to complete.The default is False, which means wait for results.

Returns:

JSON message as dictionary whenfuture=False else Iffuture=True,then the result is aFuture object. Callresult() to get the response.

classmethodfromitem(item:Item)

Thefromitem method is used to create aFeatureLayerCollection from aItem class.

Parameter	Description
item	A requiredItem object. The item needed to convert toaFeatureLayerCollection object.

Returns:

AFeatureLayerCollection object.

propertygenerate_service_definition

Returns a dictionary can be used for service generation.

Returns:

dict or None (if not supported on the service)

insert_layer(data_path:str,name:str=None)

This method will create a feature layer or table and insert it into the existing feature service.If your data path will publish more than one layer or table, only the first will be added.

Argument	Description
data_path	Required string. The path to the data to be inserted. Note Shapefiles and file geodatabases must be in a .zip file.
name	Optional string. The name of the layer or table to be created.

propertylayers:list

Returns a list ofFeatureLayerManager to work with FeatureLayers

Returns:

List[FeatureLayerManager]

overwrite(data_file:str)

Overwrite all the features and layers in a hosted feature layer collection service. This operation removesall features but retains the properties (such as metadata, itemID) and capabilities configured on the service.There are some limits to using this operation:

1. Only hosted feature layer collection services can be overwritten

2. The original data used to publish this layer should be available on the portal

3. The data file used to overwrite should be of the same format and filename as the original that was used to publish the layer

4. In older versions of Enterprise (pre-11.2), the schema (column names, column data types) of the data_file should be the same as original. You can have additional or fewer rows (features).

In addition to overwriting the features, this operation also updates the data of the item used to published thislayer.

Parameter	Description
data_file	Required string. Path to the file used to overwrite the hostedfeature layer collection.

Returns:

JSON message as dictionary such as {‘success’:True} or {‘error’:’error message’}

propertyproperties

Theproperties property retrieves and set properties of this object.

refresh()

refreshes a feature layer collection

swap_view(index:int,new_source:FeatureLayer|Table,future:bool=False)→dict|Future

Swaps the Data Source Layer with a different parent layer.

Parameter	Description
index	Required int. The index of the layer on the view to replace.
new_source	Required FeatureLayer or Table. The layer to replace the existingsource with.
future	Optional Bool. When True, a Future object will be returned else aJSON object.

Returns:

dict | concurrent.futures.Future

propertytables:list

Returns a list ofFeatureLayerManager to work with tables

Returns:

List[FeatureLayerManager]

update_definition(json_dict:dict[str,Any],future:bool=False)

The update_definition operation supports updating a definitionproperty in a hosted feature layer collection service. The result of thisoperation is a response indicating success or failure with errorcode and description.

Parameter	Description
json_dict	Required dict. The part to add to the hosted service. The formatcan be derived from theproperties property.For layer level modifications, run updates on each individual featureservice layer object.
future	Optional boolean. If True, a future object will be returns and the processwill not wait for the task to complete.The default is False, which means wait for results.

Returns:

JSON message as dictionary whenfuture=Falsewhenfuture=True,Future object is returned. Callresult() to get the response.

propertywebhook_manager:WebHookServiceManager

Returns:

WebHookServiceManager

If theuser has the appropriate privileges to access this class, it allowsfor updating the definition of aFeatureLayer.This class is not typically initialized by end users, but instead accessedas themanager property of theFeatureLayer.

# Usage Example>>>fromarcgis.gisimportGIS>>>gis=GIS(profile="your_user_profile")>>>item=gis.content.search("Flood Damage","Feature Layer")[0]>>>flood_flyr=item.layers[0]>>>flood_mgr=flood_flyr.manager>>>type(flood_mgr)<class'arcgis.features.managers.FeatureLayerManager'>

add_to_definition(json_dict:dict[str,Any],future:bool=False)

This method adds a definition property to a previously published service.

Parameter	Description
json_dict	Required dict. The part to add to the hosted service. The formatcan be derived from theproperties property. For layer levelmodifications, run updates on each individual feature layer of theservice. Find more information on what this dictionary can contain at:https://developers.arcgis.com/rest/services-reference/enterprise/layer-feature-service/#json-response-syntax
future	Optional boolean. The default isFalse, which means to run themethod synchronously and wait for results. IfTrue, the method runsasynchronously. Asynchronous operation only supported in ArcGIS Online andArcGIS Enterprise.

Returns:

• If run synchronously (future=False), a JSON message as a dictionary indicating ‘success’ or ‘error’

• If run asynchronously (future = True):

  • OnArcGIS Enterprise and ArcGIS Online, aFutureobject. Callresult() to get the response.

  • Asynchronous operation not supported in ArcGIS Online for Kubernetes.

# Usage Example: ArcGIS Enterprise for Kubernetes:>>>fromarcgis.gisimportGIS>>>gis=GIS(profile="your_kubernetes_profile")>>>item=gis.content.get("<feature_layer_item_id>")>>>fl=item.layers[0]>>>new_field={"fields":[{"name":"Loc Identifier","type":"esriFieldTypeString","alias":"safa","nullable":True,"editable":True,"length":256,}]}>>>res=fl.manager.add_to_definition(json_dict=add_field)>>>res{'success':True}# Usage Example 2: ArcGIS Online asynchronous>>>gis=GIS(profile="your_online_profile")>>>item=gis.content.get("<feature_layer_item_id>")>>>fl=item.layers[0]>>>new_field={"fields":[{"name":"Loc Identifier","type":"esriFieldTypeString","alias":"safa","nullable":True,"editable":True,"length":256,}]}>>>future=fl.manager.add_to_definition(json_dict=add_field,future=True)>>>res=future.result()>>>res{'submissionTime':<time_value>,'lastUpdatedTime':<time_value>,'status':'Completed'}

propertycontingent_values:dict[str,Any]

returns the contingent values for the service endpoint

delete_from_definition(json_dict:dict[str,Any],future:bool=False)

This method deletes a definition property from a hosted feature layer.See:Delete From Definition (Feature Service)for additional information on this function.

Parameter	Description
json_dict	Required dict. The part to add to the hosted service. The formatcan be derived from theproperties property.For layer level modifications, run updates on each individual featureservice layer object.Only include the items you want to remove from the FeatureService or layer.
future	Optional boolean. The default isFalse, which means to run themethod synchronously and wait for results. IfTrue, the method runsasynchronously. Asynchronous operation only supported in ArcGIS Online andArcGIS Enterprise.

Returns:

• If run synchronously (future=False), a JSON message as a dictionary indicating ‘success’ or ‘error’

• If run asynchronously (future = True):

  • OnArcGIS Enterprise and ArcGIS Online, aFutureobject. Callresult() to get the response.

  • Asynchronous operation not supported in ArcGIS Online for Kubernetes.

propertyfield_groups:dict[str,Any]

returns the field groups for the service endpoint

classmethodfromitem(item:Item,layer_id:int=0)

Creates aFeatureLayerManager object from a GIS Item.

Parameter	Description
item	Required of typeFeatureService that representsaFeatureLayerCollection .
layer_id	Required int. Id of the layer in theFeatureLayerCollection

Returns:

FeatureLayer created from the layer provided.

propertyproperties

Theproperties property retrieves and set properties of this object.

refresh()

refreshes a service

truncate(attachment_only:bool=False,asynchronous:bool=False,wait:bool=True)

The truncate operation supports deleting all features or attachmentsin a hosted feature service layer. The result of this operation is aresponse indicating success or failure with error code and description.SeeTruncate (Feature Layer)for additional information on this method.

Note

Thetruncate method is restricted tolayers that:

• do not serve as the origin in a relationship with otherlayers

• do not reference the same underlying database tables that arereferenced by other layers (for example, if the layer waspublished from a layer with a definition query and aseparate layer has also been published from that source)

• do not havesync enabled

Parameter	Description
attachment_only	Optional boolean. If True, deletes all the attachments for this layer.None of the layer features will be deleted.
asynchronous	Optional boolean. If True, supports asynchronous processing. Thedefault is False. It is recommended to set asynchronous=True forlarge datasets.
wait	Optional boolean. If True, then wait to pause the process untilasynchronous operation is completed. Default is True.

Returns:

JSON Message as dictionary indicatingsuccess orerror

update_definition(json_dict:dict[str,Any],future:bool=False)

This method modifies a definition of a hosted feature layer.

Parameter	Description
json_dict	Required dict. The part to add to the hosted service. The formatcan be derived from theproperties property.For layer level modifications, run updates on each individual featureservice layer object.
future	Optional boolean. The default isFalse, which means to run themethod synchronously and wait for results. IfTrue, the method runsasynchronously. Asynchronous operation only supported in ArcGIS Online andArcGIS Enteprise.

Returns:

• If run synchronously (future=False), a JSON message as a dictionary indicating ‘success’ or ‘error’

• If run asynchronously (future = True):

  • OnArcGIS Enterprise and ArcGIS Online, aFutureobject. Callresult() to get the response.

  • Asynchronous operation not supported in ArcGIS Online for Kubernetes.

VersionManager allows users to manage the branch versioning forFeatureLayerCollectionservices. The Version Management Service is responsible for exposing the managementcapabilities necessary to support feature services that work with branch versioneddatasets.

See theVersion Management Service for more information

propertyall

returns all visible versions on a service

create(name:str,permission:str='public',description:str='')→dict

Create the named version off of DEFAULT. The version is associatedwith the specified feature service. During creation, the descriptionand access (default is public) may be optionally set.

Parameter	Description
name	Required String. The name of the version
permission	Optional String. The access permissions of the new version. Thedefault access permission is public. Values: “private” | “public” | “protected” | “hidden”
description	Optional String. The description of the new version

Returns:

Dictionary with Version Information

get(version:str,mode:str|None=None)

Finds and Locations a Version by it’s name

Parameter	Description
version	Required String. This is the name of the version to locate.
mode	Optional String. This allows users to get a version in a specificstate of edit or read. If None is provided (default) the versionis created without entering a mode. Values: edit - starts editing mode read - starts reading mode None - no mode is started. This is default.

propertylocks

For the specified feature service, return the versions which are locked.

Returns:

List of locked versions

propertyproperties

returns the service properties

purge(version:str,owner:str|None=None)

Removes a lock from a version

Parameter	Description
version	Required String. The name of the version that is locked.
owner	Required String. The owner of the lock. (Deprecated)

Returns:

Boolean. True if successful else False.

search(owner:str|None=None,show_hidden:bool=False)

For the specified feature service, return the info of all versionsthat the client has access to. If the client is the service owner(the user that published the service), all versions are accessibleand will be returned.

Parameter	Description
owner	Optional String. A filter the versions by the owner.
show_hidden	Optional Boolean. If False (default) hidden versions will not bereturned.

Returns:

Dictionary indication ‘success’ or ‘error’

AVersion represents a single branch in the version tree.

alter(owner:str|None=None,version:str|None=None,description:str|None=None,permission:str|None=None)

Thealter operation changes the geodatabase version’s name,description, and access permissions.

Parameter	Description
owner	Optional String. The new name of the owner.
version	Optional String. The new name of the version.
permission	Optional String. The new access level of the version. Values: “private” | “public” | “protected” | “hidden”
description	Optional String. The description of the new version

Returns:

Boolean. True if successful else False.

conflicts()

Theconflicts operation allows you to view the conflicts by layerand type (update-update, update-delete, delete-update) that wereidentified during the last Reconcile operation. The features thatare in conflicts will also be returned as they existed in the branch,ancestor, and default versions.

delete()

Deletes the current version

Returns:

Boolean. True if successful else False.

delete_forward_edits(moment:str)

If the input moment does not match a specific moment (a momentcorresponding to an edit operation), the call will return an error.The client app must correctly manage the edit session’s editoperations moments (for example, the undo/redo stack) and notblindly pass in a timestamp that could mistakenly delete all theforward moments. Thus, the input moment must be equal to a momentin which an edit operation for the version was applied. The callwill also fail if the session does not have a write lock on theversion.

Parameter	Description
moment	Required String. Moment representing the new tail of the version;all forward moments will be trimmed.

Returns:

Boolean. True if successful else False.

differences(result_type='objectIds',moment=None,from_moment=None,layers=None,future=False)

Thedifferences operation allows you to view differences betweenthe current version and the default version. The two versions canbe compared to check for the following conditions.

• Inserts - features that are present in the current version but not the default version

• Updates - features that have different attributes or geometry in the current version than the default version

• Deletions - features that are present in the default version but not in the current version

Both differences and conflicts will be returned. It is the clients’responsibility to determine which are differences, and which are conflicts.

Parameter	Description
result_type	Required String. Determines the type of results to return.The default result type isobjectIds. Values : “objectIds” | “features”
moment	Required String. Moment used to compare current version withdefault.
from_moment	Optional string. Time epoch value in milliseconds specifying thetime from which to obtain the differences between this valueand the specifiedmoment argument value. Note By default, if this parameter is not specified, thedifferences operation returns the edits (inserts, updates, and deletes) at the specified value of themoment argument. This parameter is only supported on the default version. For a named branch, this parameter will return an error if specified. The common ancestor moment is automatically used. This parameter was introduced at ArcGIS Enterprise 10.9
layers	Optional list. The layer id values for which differences shouldbe returned. If not specified, the differences for all layers willbe returned.
future	Optional boolean. IfTrue, the method runs as an asynchronousjob returning a _URL_ value to inspect the status of the job. Thedefault value isFalse.

Returns:

Dictionary with adifferences key indicating the variousinserts,updates,ordeletes for each layer.

edit(layer:FeatureLayer,adds:FeatureSet|list|None=None,updates=None,deletes=None,use_global_ids=False,rollback_on_failure=True)

Theedit operation allows users to apply changes to the current version. The editsession must be in the mode ofedit or an exception will be raised.

Inputs	Description
layer	RequiredFeatureLayer . The layer to performthe edit on.
adds	OptionalFeatureSet /List. The array offeatures to be added.
updates	OptionalFeatureSet /List. The array offeatures to be updated.
deletes	OptionalFeatureSet /List. String of OIDs toremove from service
use_global_ids	Optional boolean. Instead of referencingthe default Object ID field, the servicewill look at a GUID field to track changes.This means the GUIDs will be passed insteadof OIDs for delete, update or add features.
rollback_on_failure	Optional boolean. Optional parameter tospecify if the edits should be applied onlyif all submitted edits succeed. If false, theserver will apply the edits that succeedeven if some of the submitted edits fail.If true, the server will apply the editsonly if all edits succeed. The defaultvalue is true.

Returns:

Dictionary

inspect(conflicts:list[dict[str,Any]],inspect_all:bool=False,set_inspected:bool=False)

Theinspect operation allows the client to annotate conflictsfrom the conflict set that was obtained during the last reconcileoperation. Users can mark the conflicts as being inspected;additionally, a description or note can be associated with theconflict.

Parameter	Description
conflicts	Required List. The conflicts that are being inspected (removed)from the conflict set. Parameter Format: [{ “layerId” : <layerId>, “features” : [{ “objectId” : <objectId>, “note” : string }]}] The objectId key is required. The note parameter is optional.
inspect_all	Optional Boolean. This parameter, if true, will mark all conflictsas being inspected.
set_inspected	Optional Boolean. If True, the examined values will be set toinspected. Ifinspect_all is True, this parameter is ignored.

Returns:

Boolean. True if successful else False.

propertylayers

returns the layers in theFeatureLayerCollection

propertymode

Themode allows version editors to start and stop edit, read, orview mode.

Parameter	Description
value	Required string. Values: edit - calls thestart_editing method and creates a lock read - calls thestart_reading method and creates a lock None - terminates all sessions and lets a user view the version information (default)

propertyparcel_fabric

Provides access to a parcel fabric manager

Returns:

ParcelFabricManager

post(rows=None,future=False)

The Post operation allows the client to post the changes in theirbranch to the default version. The client can only post changes ifthe branch version has not been modified since the last reconcile.If the default version has been modified in the interim, the clientwill have to reconcile again before posting.

Parameter	Description
rows	Optional List of dictionaries representing the features or objectsfor posting a subset of edits in the current version. TheobjectIds specified must be edits contained within the currentversion, which can be obtained from thedifferences() method. Theposted edits will no longer exist in the current version, anotherreconcile() is necessaryto see the posted features. rows=[{"layerId":0,"objectIds":[14,15,17,20]},{"layerId":1},"objectIds":[123]}]
future	Optional Boolean. If “True”, the operation runs as an asynchronousjob. The results are returned as a Url pointing to a location thatindicates the status of the job.

Returns:

Boolean.True or a job URL if successful, elseFalse.

propertyproperties

returns the service properties

reconcile(end_with_conflict:bool=False,with_post:bool=False,conflict_detection:str='byObject',future:bool=False)

Reconcile a version against the DEFAULT version. The reconcileoperation requires that you are the only user currently editing theversion and the only user able to edit the version throughout thereconcile process until you save or post. The reconcile operationrequires that you have full permissions to all the feature classesthat have been modified in the version being edited. The reconcileoperation detects differences between the branch version and thedefault version and flags these differences as conflicts. Ifconflicts exist, they should be resolved.

Parameter	Description
end_with_conflict	Optional Boolean. Specifies if the reconcile should abort whenconflicts are found. The default is False
with_post	Optional Boolean. If True the with_post causes a post of the currentversion following the reconcile.
conflict_detection	Optional String. Specify whether the conditions required forconflicts to occur are defined by object (row) or attribute (column). The default isbyObject. Note This parameter was introduced at ArcGIS Enterprise 10.9 Values: byObject | byAttribute
future	Optional boolean. IfTrue, the request is processed as an asynchronousjob and a URL is returned that points a location displaying the statusof the job. Note This parameter was introduced at ArcGIS Enterprise 10.9.1 The default isFalse.

Returns:

Boolean.

Iffuture=True, then the result is aFuture object. Callresult() to get the response.

restore(rows:list[dict[str,Any]])

Therestore method allows users to restore rows from a commonancestor version. This method is intended to be used when aDeleteUpdate conflicts are identified during the last reconcile.

Parameter	Description
rows	Required List. An array of the rows to be restored Syntax [{ “layerId”: <layerId>, “objectIds”:[<objectId>] }]

Returns:

Boolean and String.Bool: True if successful else False.String: the moment

propertysave_edits

Get/Set the Property to Save the Changes.

Parameter	Description
value	Required bool.Values: True | False

When set to true, any edits performed on the version will be saved.

start_editing()

Starts an edit session for the current user.

Returns:

Boolean. True if successful else False.

start_reading()

Start reading represents a long-term service session. Whenstart_readingis enabled, it will prevent other users from editing or reconciling theversion.

Returns:

Boolean. True if successful else False.

stop_editing(save:bool|None=None)

Starts an edit session for the current user.

Parameter	Description
save	Optional Boolean. States if the values should be saved. If the valueis set, it will override thesave_edits property.

Returns:

Boolean. True if successful else False.

stop_reading()

Stops and releases a reading session.

Returns:

Boolean. True if successful else False.

propertytables

returns the tables in theFeatureLayerCollection

propertyutility

provides access to the utility service manager

propertyvalidation

Provides access to a validation manager.

Returns:

ValidationManager

The Parcel Fabric Server is responsible for exposing parcel managementcapabilities to support a variety of workflows from different clientsand systems.

analyze_least_squares_adjustment(analysis_type:str='CONSISTENCY_CHECK',convergence_tolerance:float=0.05,parcel_features:dict[str,Any]|None=None,future:bool=False)

Note

Least Squares Adjustment functionality introduced at version 10.8.1

Analyzes the parcel fabric measurement network by running a least squares adjustment on theinput parcels. A least-squares adjustment is a mathematical procedure that uses statisticalanalysis to estimate the most likely coordinates for connected points in a measurement network.

Useapply_least_squares_adjustment()to apply the results of a least squares adjustment to parcel fabric feature classes.

Parameter	Description
analysis_type	Optional string. Represents the type of least squares analysis that will be run on the input parcels. CONSISTENCY_CHECK - A free-network least-squares adjustment will be run to check dimensions onparcel lines for inconsistencies and mistakes. Fixed or weighted control points will not beused by the adjustment. WEIGHTED_LEAST_SQUARES - A weighted least-squares adjustment will be run to compute updatedcoordinates for parcel points. The parcels being adjusted should connect to at least two fixedor weighted control points. The default value is CONSISTENCY_CHECK.
convergence_tolerance	Optional float. Represents the maximum coordinate shift expected after iterating the least squares adjustment. A leastsquares adjustment is run repeatedly (in iterations) until the solution converges. The solution isconsidered converged when maximum coordinate shift encountered becomes less than the specified convergencetolerance. The default value is 0.05 meters or 0.164 feet.
parcel_features	Optional list. Represents the input parcels that will be analyzed by a least squares adjustment. Syntax: >>>parcel_features=[{"id":"<guid>","layerId":"<layerID>"},{...}] If None, the method will analyze the entire parcel fabric.
future	Optional boolean. IfTrue, the request is processed as anasynchronous job and a URL is returned that points a locationdisplaying the status of the job. The default isFalse.

Returns:

Boolean.True if successful elseFalse

apply_least_squares_adjustment(movement_tolerance:float=0.05,update_attributes:bool=True,future:bool=False)

Note

Least Squares Adjustment functionality introduced at version 10.8.1

Applies the results of a least squares adjustment to parcel fabric feature classes. Least squares adjustment results storedin the AdjustmentLines and AdjustmentPoints feature classes are applied to the corresponding parcel line, connection line,and parcel fabric point feature classes.

Useanalyze_least_squares_adjustment()to run a least-squares analysis on parcels and store the results in adjustment feature classes.

Parameter	Description
movement_tolerance	Optional float. Represents the minimum allowable coordinate shift when updating parcel fabric points. If the distance betweenthe adjustment point and the parcel fabric point is greater than the specified tolerance, the parcel fabricpoint is updated to the location of the adjustment point. The default tolerance is 0.05 meters or 0.164 feet.
update_attributes	Optional boolean. Specifies whether attribute fields in the parcel fabric Points feature class will be updated withstatistical metadata. The XY Uncertainty, Error Ellipse Semi Major, Error Ellipse Semi Minor, andError Ellipse Direction fields will be updated with the values stored in the same fields in the AdjustmentPointsfeature class. The default isTrue
future	Optional boolean. IfTrue, the request is processed as an asynchronous job and a URL is returned that points a locationdisplaying the status of the job. The default isFalse.

Returns:

Boolean.True if successful elseFalse

assign_to_record(features:list[dict[str,Any]],record:str,write_attribute:str,moment:int|str|None=None,future:bool=False)

Assigns the specified parcel features to the specified record. Ifparcel polygons are assigned, the record polygon will be updated tomatch the cumulative geometry of all the parcels associated to it.The Created By Record or Retired By Record attribute field of theparcel features is updated with the global ID of the assignedrecord.

Parameter	Description
features	Required List. The parcel features to assign to the specified record.Can be parcels, parcel polygons, parcel points, and parcel lines. Syntax: >>>features=[{"id":"<guid>","layerId":"<layerID>"},{...}]
record	Required String. The record that will be assigned to the specifiedparcel features.
write_attribute	Required String. Represents the record field to update on the parcelfeatures. Either the Created By Record or Retired By Record field isto be updated with the global ID of the assigned record. Allowed Values: CreatedByRecord orRetiredByRecord
moment	Optional Integer. This should only be specified by the client whenthey do not want to use the current moment
future	Optional boolean. IfTrue, the request is processed as an asynchronousjob and a URL is returned that points a location displaying the statusof the job. The default isFalse.

Returns:

Boolean.True if successful otherwiseFalse

build(extent:dict|Envelope|None=None,moment:int|str|None=None,return_errors:bool=False,record:str|None=None,future:bool=False)

Abuild will fix known parcel fabric errors.

For example, if a parcel polygon exists without lines, then build willconstruct the missing lines. If lines are missing, the polygon row(s)are created. When constructing this objects, build will attribute therelated keys as appropriate. Build also maintainslineage andrecordfeatures. The parcel fabric must have sufficient information for buildto work correctly. Ie, source reference document, and connected lines.

Build provides options to increase performance. The process can justwork on specific parcels, geometry types or only respond to parcel pointmovement in the case of an adjustment.

Parameter	Description
extent	OptionalEnvelope . The extent to build. Syntax: >>>extent={ "xmin":X min, "ymin": y min, "xmax": x max, "ymax": y max, "spatialReference": {"wkid": <wkid_value>} }
moment	Optional String. This should only be specified by the client whenthey do not want to use the current moment
return_errors	Optional Boolean. IfTrue, a verbose response will be given if errorsoccured. The default isFalse.Deprecated
record	Optional String. Represents the record identifier (guid). If arecord guid is provided, only parcels associated to the record arebuilt, regardless of the build extent.
future	Optional boolean. IfTrue, the request is processed as an asynchronousjob and a URL is returned that points a location displaying the statusof the job. The default isFalse.

Returns:

Boolean.True if successful elseFalse

change_type(parcels:list[dict[str,Any]],target_type:str,parcel_subtype:int|str=0,moment:int|str|None=None,future:bool=False)

Changes a set of parcels to a new parcel type. It creates newpolygons and lines and deletes them from the source type. Thisis used when a parcel was associated in the wrong parcel type subtypeand/or when creating multiple parcels as part of a build process.Example: when lot parcels are created as part of a subdivision, theroad parcel is moved to the encumbrance (easement) parcel type.

Parameter	Description
parcels	Required List. Parcels list that will change type
target_type	Required String. The target parcel layer
target_subtype	Optional Integer. Target parcel subtype. The default is 0 meaningno subtype required.
moment	Optional String. This parameter represents the session moment (thedefault is the version current moment). This should only bespecified by the client when they do not want to use the currentmoment.
future	Optional boolean. IfTrue, the request is processed as an asynchronousjob and a URL is returned that points a location displaying the statusof the job. The default isFalse.

Returns:

Boolean.True if successful elseFalse

clip(parent_parcels:list[dict[str,Any]],clip_record:str|None=None,clipping_parcels:list[dict[str,Any]]|None=None,geometry:Polygon|None=None,moment:int|str|None=None,option:str|None=None,area_unit:str|None=None,future:bool=False)

Clip cuts a new child parcel into existing parent parcels. Commonlyit retires the parent parcel(s) it cuts into to generate a reminderchild parcel. This type of split is often part of aparcel splitmetes and bounds record driven workflow.

Parameter	Description
parent_parcels	parent parcels that will be clipped into. Syntax: >>>parent_parcels=<parcel(guid)+layer(name)...>
clip_record	Optional String. It is the GUID for the active legal record.
clipping_parcels	Optional List. A list of child parcels that will be used to clipinto the parent parcels. Parcel lineage is created if the child‘clipping_parcels’ and the parcels being clipped are of the sameparcel type. Syntax: clipping_parcels=<"id":"parcelguid","layerId":"<layerid>"...> # Example:>>>clipping_parcels=[{"id":"{D01D3F47-5FE2-4E39-8C07-E356B46DBC78}","layerId":"16"}] Note Eitherclipping_parcels orgeometry is required.
geometry	Optional Polygon. Allows for the clipping a parcel based on geometry instead of‘clipping_parcels’ geometry. No parcel lineage is created. Note Eitherclipping_parcels orgeometry is required.
moment	Optional String. This should only be specified by the client whenthey do not want to use the current moment
option	Optional String. Represents the type of clip to perform: PreserveArea - Preserve the areas that intersect and discard the remainder areas. (default) DiscardArea - Discard the areas that intersect and preserve the remainder areas. PreserveBothAreasSplit - Preserve both the intersecting and remainder areas.
area_unit	Optional String. Area units to be used when calculating the statedareas of the clipped parcels. The stated area of the clipped parcelswill be calculated if the stated areas exist on the parent parcelsbeing clipped.
future	Optional boolean. IfTrue, the request is processed as an asynchronousjob and a URL is returned that points a location displaying the statusof the job. The default isFalse.

Returns:

Dictionary indicating ‘success’ or ‘error’

copy_lines_to_parcel_type(parent_parcels:list[dict[str,Any]],record:str,target_type:int|str,moment:int|str|None=None,mark_historic:bool=False,use_source_attributes:bool=False,attribute_overrides:dict[str,Any]|None=None,use_polygon_attributes:bool=False,parcel_subtype:int|None=None,future:bool=False)

Copy lines to parcel type is used when the construction of thechild parcel is based on parent parcel geometry. It creates acopy of the parent parcels lines that the user can modify (insert,delete, update) before they build the child parcels. If the sourceparcel type and the target parcel type are identical (common)parcel lineage is created.

Parameter	Description
parent_parcels	Required String. Parcel parcels from which lines are copied.
record	Required String. The unique identifier (guid) of the active legalrecord.
target_type	Required String. The target parcel layer to which the lines will becopied to.
moment	Optional String. This parameter represents the session moment (thedefault is the version current moment). This should only bespecified by the client when they do not want to use the currentmoment.
mark_historic	Optional Boolean. Mark the parent parcels historic. The default isFalse.
use_source_attributes	Optional Boolean. If the source and the target line schema match,attributes from the parent parcel lines will be copied to the newchild parcel lines when it is set toTrue. The default isFalse.
use_polygon_attributes	Optional Boolean. Parameter representing whether to preserve andtransfer attributes of the parent parcels to the generated seeds.
attribute_overrides	Optional Dictionary. To set fields on the child parcel lines with aspecific value. Uses a key/value pair of FieldName/Value. Syntax: >>>attributeOverrides=[{"type":"PropertySet", "propertySetItems": [ <field name>, <field value> ] }]
parcel_subtype	Optional Integer. Represents the target parcel subtype.
future	Optional boolean. IfTrue, the request is processed as an asynchronousjob and a URL is returned that points a location displaying the statusof the job. The default isFalse.

Returns:

Dictionary indicating ‘success’ or ‘error’

create_seeds(record:str,moment:int|str|None=None,extent:dict|Envelope|None=None,future:bool=False)

Create seeds creates parcel seeds for closed loops of lines thatare associated with the specified record.

When building parcels from lines, parcel seeds are used. A parcelseed is the initial state or seed state of a parcel. A parcel seedindicates to the build process that a parcel can be built from thelines enclosing the seed.

A parcel seed is a minimized polygon feature and is stored in theparcel type polygon feature class.

Parameter	Description
record	Required String. AGUID representing the record that will beassigned to the features set as current or historic.
moment	Optional String. This parameter represents the session moment (thedefault is the version current moment). This should only bespecified by the client when they do not want to use the currentmoment.
extent	Optional Dict/Envelope . The envelope of the extentin which to create seeds.
future	Optional boolean. IfTrue, the request is processed as an asynchronousjob and a URL is returned that points a location displaying the statusof the job. The default isFalse.

Returns:

Dictionary indicating ‘success’ or ‘error’

delete(parcels:list[dict[str,Any]],moment:int|str|None=None,future:bool=False)

Delete a set of parcels, removing associated or unused lines, andconnected points.

Parameter	Description
parcels	Required List. The parcels to erase.
moment	Optional String. This parameter represents the session moment (thedefault is the version current moment). This should only bespecified by the client when they do not want to use the currentmoment.
future	Optional boolean. IfTrue, the request is processed as an asynchronousjob and a URL is returned that points a location displaying the statusof the job. The default isFalse.

Returns:

Dictionary indicating ‘success’ or ‘error’

divide(divide_parcel_guid:str,divide_parcel_type:int|str|None,divide_record:str,divide_option:str,divide_number_of_parts:int|str,divide_part_area:float|int,divide_line_bearing:float,divide_left_side:bool,divide_distribute_remainder:bool,default_area_unit:int|str|None=None,divide_cogo_line_bearing:float=None,divide_associated_lines:bool=False,future:bool=False)

Note

Divide functionality introduced at version 10.9.1

Divide a polygon feature into multiple features that have proportional or equal areas, or equal widths.

Parameter	Description
divide_parcel_guid	Required String. Parameter for the unique identifierguid of theparcel being divided.
divide_parcel_type	Required Integer. Parameter representing the parcel type layer ID inwhich the new, divided parcels will be created.
divide_record	Required String. Parameter for the unique identifierguid of therecord being used for the divide.If missing, no parcel history is created.
divide_option	Required String. The type of division to be performed. ProportionalArea EqualArea EqualWidth
divide_number_of_parts	Required Integer. The number parts into which the parcel willbe divided.
divide_part_area	Required Float. Area (or width) of each part (parcel fabric GDB units squared). Note This value is ignored when dividing by proportional area. Adefault value of 0 will be applied.
divide_line_bearing	Required Float. The direction (in decimal degrees) of the lineused to divide the parcel.
divide_left_side	Required Boolean. Parameter indicating if area being divided isstarting from the leftmost edge of the parcel. Any remainder areawill be to the right of the divided parts. IfFalse, the area beingdivided starts from the rightmost edge of the parcel and any remainderarea will be to the left of the divided parts. This parameter is required for theEqualArea andEqualWidthdivide options. Note This value is ignored when dividing by proportional area. Adefault value ofFalse will be applied.
divide_distribute_remainder	Required Boolean. Indicates whether to distribute or merge theremainder area after the divide is performed. This parameter is usedfor theEqualArea andEqualWidth divide options. Note This value is ignored when dividing by proportional area. Adefault value ofFalse will be applied.
default_area_unit	Required Integer. The units in which area will be stored. The parameteris specified as a domain code from thePF_AreaUnits parcel fabricdomain. #Example Usage:#Square feet>>>default_area_unit=109405#Square meters>>>default_area_unit=109404
divide_cogo_line_bearing	Optional Float. Parameter representing the COGO direction(in decimal degrees) that will be stored in the COGO Direction fieldof the dividing lines.
divide_associated_lines	Optional boolean. If true, boundary lines of divided parcels will be split.The original parent lines will be set as historic. The default isFalse.
future	Optional boolean. IfTrue, the request is processed as an asynchronousjob and a URL is returned that points a location displaying the statusof the job. The default isFalse.

Returns:

Dictionary indicating ‘success’ or ‘error’