arcgis.features.managers module

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, file_path, keywords=None, return_moment=False)

Adds an attachment to a FeatureLayer. Adding an attachment is 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 feature attachment. The content type, size, and name of the attachment will be derived from the uploaded file.
keywords	Optional string. Sets a text value that is stored as the keywords value for the attachment. This parameter can be set when the layer has an attachmentProperties property that includes “name”: “keywords” with “isEnabled”: True. If the attachments have keywords enabled and 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 time attachments were added. If True, the server will return the time in the response’s editMoment key. The default is False.

Returns

A JSON Response stating ‘success’ or ‘error’

count(where=None, attachment_where=None, object_ids=None, global_ids=None, attachment_types=None, size=None, keywords=None)

delete(oid, attachment_id, return_moment=False, rollback_on_failure=True)

Removes an attachment from a FeatureLayer . Deleting an attachment is a feature update; it requires the Update capability. The deleteAttachments operation is performed on a feature 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 time attachments were deleted. If True, the server will report the time in the response’s editMoment key. The default value is False.
rollback_on_failure	Optional boolean. Specifies whether the edits should be applied only if all submitted edits succeed. If False, the server will apply the 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=None, attachment_id=None, save_path=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 value to download data from.
attachment_id	Optional string. Id of the attachment to download. This is only honored 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)

Get the list of attachements for a given OBJECT ID

Parameter	Description
oid	Required string of the object id

Result

A list of attachements

search(where='1=1', object_ids=None, global_ids=None, attachment_types=None, size=None, keywords=None, show_images=False, as_df=False, return_metadata=False, return_url=False, max_records=None, offset=None, *, attachment_where=None)

The search method allows querying the layer for its attachments and returns the results as a Pandas DataFrame or dict

Parameter	Description
where	Required string. The definition expression to be applied to the related layer/table. From the list of records that are related to the specified object Ids, only those records that conform 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 be queried. 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 be queried. 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 specified global id.
attachment_types	Optional list/string. The file format that is supported by query 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 is specified 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 the specified file size range (1000 - 15000) bytes.
keywords	Optional string. When attachments are uploaded, keywords can be 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 is set to False, this parameter will be ignored.
as_df	Optional bool. Default is False, if True, the results will be a Pandas’ DataFrame. If False, the values will be a list of dictionary values.
return_metadata	Optional Boolean. If true, metadata stored in the exifInfo column will be returned for attachments that have exifInfo. This option is supported only when “name”: “exifInfo” in the layer’s attachmentProperties includes “isEnabled”: true. When set to false, or not set, None is returned for exifInfo.
return_url	Optional Boolean. Specifies whether to return the attachment URL. The default is false. This parameter is supported if the supportsQueryAttachmentsWithReturnUrl property is true on the layer. Applications can use this URL to download the attachment image.
max_records	Optional Integer. This option fetches query results up to the resultRecordCount specified. When resultOffset is specified and this parameter is not, the feature service defaults to the maxRecordCount. The maximum value for this parameter is the value of the layer’s maxRecordCount property. This parameter only applies if supportPagination is true.
offset	Optional Integer. This parameter is designed to be used in conjunction with max_records to page through a long list of attachments, one request at a time. This option fetches query results by skipping a specified number of records. The query results start from the next record (i.e., resultOffset + 1). The default value is 0. This parameter only applies when supportPagination is true. You can use this option to fetch records that are beyond maxRecordCount property.
attachment_where	Optional str. The definition expression to be applied to the attachments table. Only those records that conform to this expression will be returned. You can get the attachments table field names to use in the expression by checking the layer’s attachmentProperties.

Returns

A Pandas DataFrame or Dict of the attachments of the FeatureLayer

update(oid, attachment_id, file_path, return_moment=False)

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 feature attachment.
return_moment	Optional boolean. Specify whether the response will report the time attachments were deleted. If True, the server will report the time in the response’s editMoment key. The default value is False.

Result

JSON response stating ‘success’ or ‘error’

Manager class for manipulating replicas for syncing disconnected editing of FeatureLayer . This class is not created by users directly. An instance of this class, called ‘replicas’, is available as a property of the FeatureLayerCollection 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, retention_period, period_unit='days', min_server_gen=None, replica_id=None, future=False)

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

Only the owner or the organization administrator can cleanup change tracking 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 the change tracking information. Change tracking information will be cleaned up if they are older than the retention period.
period_unit	Optional String. The units of the retention period. Values: days, seconds, minutes, or hours
min_server_gen	Optional String. In addition to the retention period, the change tracking can be cleaned by its generation numbers. Older tracking information that has older generation number than the min_server_gen will be cleaned.
replica_id	Optional String. The change tracking can also be cleaned by the replica_id in addition to the retention_period and the min_server_gen.
future	Optional boolean. If True, a future object will be returned and the process will not wait for the task to complete. The default is False, which means wait for results.

Returns

Boolean or If future = True, then the result is a Future object. Call result() to get the response.

create(replica_name, layers, layer_queries=None, geometry_filter=None, replica_sr=None, transport_type='esriTransportTypeUrl', return_attachments=False, return_attachments_databy_url=False, asynchronous=False, attachments_sync_direction='none', sync_model='none', data_format='json', replica_options=None, wait=False, out_path=None, sync_direction=None, target_type='client', transformations=None, time_reference_unknown_client=None)

The create operation is performed on a FeatureLayerCollection resource. This operation creates a replica on the server between the feature service and the client based on replica definition criteria supplied by the client.

The feature service must have the Sync capability. See publishing criteria for details on how to pulish services and set capabilities. The Sync overview provides additional details and links for details.

The response to this method includes the replicaID, replica generation number, and data similar to the response from the query() operation on a service. This information should be kept track of by the client because it will be needed when synchronizing changes in the local data with the replica created on the server.

See Sync response types details on the response received.

The operations allows for register exiting data for the replica by using the replica_options argument, a dictionary whose key-value pairs are detailed here.

For full details see Create 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 geometry parameters, the layer_queries parameter can be used to further define what is replicated. This parameter allows you to set properties on a per layer or per table basis. Only the properties for the layers and tables 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 from filters module to filter results by a spatial relationship with another geometry.
replica_sr	Optional WKID or a spatial reference JSON object. The spatial reference of the replica geometry.
transport_type	The transport_type represents the response format. If the transport_type is esriTransportTypeUrl, the JSON response is contained in a file, and the URL link to the file is returned. Otherwise, the JSON object is returned directly. The default is esriTransportTypeUrl. If async is true, the results will always be returned as if transport_type is esriTransportTypeUrl. If dataFormat is sqlite, the transportFormat will always be esriTransportTypeUrl regardless of how the parameter is set. Values: esriTransportTypeUrl | esriTransportTypeEmbedded.
return_attachments	If True, attachments are added to the replica and returned in the response. Otherwise, attachments are not included. The default is False. This parameter is only applicable if the feature service has attachments.
return_attachments_databy_url	If True, a reference to a URL will be provided for each attachment returned from create method. Otherwise, attachments are embedded in the response. The default is True. This parameter is only applicable if the feature service has attachments and if return_attachments is True.
asynchronous	If True, the request is processed as an asynchronous job, and a URL is returned that a client can visit to check the status of the job. See the topic on asynchronous usage for more information. The default is False.
attachments_sync_direction	Client can specify the attachmentsSyncDirection when creating a replica. AttachmentsSyncDirection is currently a createReplica property and cannot be overridden during sync. Values: none, upload, bidirectional
sync_model	This parameter is used to indicate that the replica is being created for per-layer sync or per-replica sync. To determine which model types are supported by a service, query the supportsPerReplicaSync, supportsPerLayerSync, and supportsSyncModelNone properties of the Feature Service. By default, a replica is created for per-replica sync. If syncModel is perReplica, the syncDirection specified during sync applies to all layers in the replica. If the syncModel is perLayer, the syncDirection 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. The replicaServerGen tells the server the point in time from which to send back changes. If sync_model is perLayer, the response will include an array of server generation numbers for the layers in layerServerGens. A perLayer sync model requires the layerServerGens on sync. The layerServerGens tell the server the point in time from which to send back changes for a specific layer. sync_model=none can be used to export the data without creating a replica. Query the supportsSyncModelNone property of the feature service to see if this model type is supported. See the RollbackOnFailure 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. The default is json. Values: filegdb, json, sqlite, shapefile
replica_options	This parameter instructs the create operation to create a new replica based on an existing replica definition (refReplicaId). It can be used to specify parameters for registration of existing data for sync. The operation will create a replica but will not return data. The responseType returned in the create response will be esriReplicaResponseTypeInfo.
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 download when the target_type is server. If set, only bidirectional is supported when target_type is client. If set, only upload or download are supported 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 is client. This option was added at 10.5.1.
transformations	Optional List. Introduced at 10.8. This parameter applies a datum transformation on each layer when the spatial reference used in geometry is different from the layer’s spatial reference.
time_reference_unknown_client	Setting time_reference_unknown_client as true indicates that the client is capable of working with data values that are not in UTC. If its not set to 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 returned as-is from the database, rather than as date values in UTC. Non-hosted feature services can be set to use an unknown time zone using ArcGIS Server Manager. Setting the time zones to unknown also sets the datesInUnknownTimeZone layer property as true. Currently, hosted feature services do not support this setting. This setting does not apply to editor tracking date fields which are stored 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 able to work with feature services that have an unknown time setting. The timeReferenceUnknownClient parameter prevents these clients from working with the service in order to avoid problems.. Setting this parameter to true indicates that the client is capable of working with unknown date values that are not in UTC.

Returns

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

create_replica_item(replica_name, item, destination_gis, layers=None, extent=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	Required GIS 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)

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

Returns

The replica information

get_list()

returns all the replicas for the feature layer collection

sync_replicated_items(parent, child, replica_name)

Synchronizes two replicated items between portals

Parameter	Description
parent	Required Item that points to the feature service that is the parent dataset. (source)
child	Required Item that points to the feature service that 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, transport_type='esriTransportTypeUrl', replica_server_gen=None, return_ids_for_adds=False, edits=None, return_attachment_databy_url=False, asynchronous=False, sync_direction='snapshot', sync_layers='perReplica', edits_upload_id=None, edits_upload_format=None, data_format='json', rollback_on_failure=False)

The synchronize operation synchronizes data between a local copy of data created by a client and a feature service based on a replica_id value obtained when creating the replica. See Sync overview for more information on the process.

The client obtains the replica_id by first calling the create() operation. Synchronize applies the client’s data changes by importing them onto the server. It then exports the changes from the server that have taken place since the last time the client retrieved the server’s data. Edits can be supplied in the edits parameter or by using the edits_uploads_id and edits_upload_format arguments to identify a file item containing the edits that were previously uploaded using the upload() method.

The response for this operation includes a replicaID value, new replica generation number, or layer’s generation numbers. The response has edits or layers according to the sync_direction/sync_layers arguments. Presence of layers and edits in the response is indicated by the responseType key.

If the responseType value is esriReplicaResponseTypeEdits or esriReplicaResponseTypeEditsAndData, the result of this operation can include lists of edit results for each layer/table edited. Each edit result identifies a single feature in a layer or row in a table and indicates if the edits were successful or not. If an edit is not successful, the edit result also includes an error code and an error description.

• If sync_model is perReplica and sync_direction is download or bidirectional, the synchronize() operation’s response will have edits.

• If sync_direction is snapshot, the response will have replacement data.

• If sync_model is perLayer, and sync_layers have sync_direction as download or bidirectional, the response will have edits.

• If sync_layers have sync_direction as download or bidirectional for some layers and snapshot for other layers, the response will have edits and data.

• If sync_direction for all the layers is snapshot, the response will have replacement data.

• If sync_model is perReplica, the create() and synchronize() responses contain replicaServerGen values.

• If sync_model is perLayer, the create() and synchronize() responses contain layerServerGens values.

See Synchronize Replica for 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 default value is esriTransportTypeUrl. Values: esriTransportTypeUrl - the response is contained in a file and a the URL link to the file is returned esriTransporTypeEmbedded - a JSON object is returned in the response Note If asynchronous is True or data_format=sqllite, the response is always returned by URL.
replica_server_gen	Required Integer. A generation number that allows the server to keep track of what changes have already been sychronized. A new replicaServerGen is sent with the response. Clients should persist this value and use it with the next call to synchronize. Note Applies when sync_model is perReplica
return_ids_for_adds	Optional Boolean. If True, the objectIDs and globalIDs of features added during the synchronize will be returned to the client in the addResults sections of the response. Otherwise, the IDs are not returned. The default is False.
edits	Optional list of dictionaries. Contains The edits the client wants to apply to the service. Note This argument can be omitted if the edits_upload_id and edits_upload_format arguments are provided instead. The edits are provided as a list where each element is a dictionary whose key-value pairs provide: id - The layer or table ID features - a dictionary of inserts, updates, and deletes. New features and updates are provided as lists of features. Deletes are provided as lists of globalIDs. attachments - a dictionary of inserts, updates, and deletes. Deletes can be specified as a list of globalIDs. Updates and adds are specified 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 attachment is 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 not embedded. Note If embedding the attachment, set the data property, otherwise set url. See edits for full details on formatting.
return_attachment_databy_url	If True, a reference to a URL will be provided for each attachment returned. Otherwise, attachments are embedded in the respose. The default is True. Note Only applies if attachments are included in the replica.
asynchronous	If True, the request is processed as an asynchronous job and a URL is returned that a client can visit and check the status. See the asynchronous operations for more information. The default is False.
sync_direction	Optional String. Determines whether to upload, download, or upload and download. By default, a replica is synchronized bi-directionally. Only applicable when sync_model is perReplica. If sync_model is perLayer, the sync_layers argument contains this information. Values: download - The changes that have taken place on the server since last download are returned. Client does not need to send any changes. If the changes are sent, service will ignore them. upload - The changes submitted in the edits or editsUploadID/editsUploadFormat parameters are applied, and no changes are downloaded from the server. bidirectional - The changes submitted in the edits or editsUploadID/editsUploadFormat parameters are applied, and changes on the server are downloaded. This is the default value. snapshot - The current state of the features is downloaded from the server. If any edits are specified, they will be ignored.
sync_layers	Required List of dictionaries specifying layer level criteria for the operation if sync_model is perLayer. The information in the dictionary allows a client to specify layer level generation numbers, and can also be used to specify individual directions for synchronization 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 when sync_model is perReplica If syncDirection value is bidirectional or download, serverGen is required The serverSibGen is only needed when syncing for replicas where the target_type argument was server when created For replicas where the syncModel value is perLayer, the serverSibGen serves the purpose of keeping track of changes already received at the layer level the same way replicaServerGen does at the replica level. It is updated when a synchronization completes. If this argument is provided and sync_direction is provided, layers in this argument that do not provide a syncDirection value will use the value of sync_direction. If sync_direction is not specificed, the default bidirectional is used.
edits_upload_id	Optinal String. The ID for the uploaded item that contains the edits the client wants to apply to the service. Used in conjunction with edits_upload_format. Note This is the id value returned when the edits were added to the service resources using upload().
edits_upload_format	Optional String. The data format of the data referenced in edit_upload_id.
data_format	Optional String. The format for the data returned in the response. The default value is json. Values: json - data is embedded in the response sqlite - a mobile geodatabase is returned which can be used in ArcGIS runtime applications
rollback_on_failure	Optional Boolean. Determines the behavior when there are errors while importing edits on the server during the operation. This only applies when sync_direction is upload or bidirectional, or the syncDirection key of an individual sync_layers element is upload or bidirectional. See the Rollback On Failure and Sync Model documentation for full details. When True, if an error occurs while importing edits on the server, all edits are rolled back and not applied. The operation returns an error in the response. Use this setting when the edits are such that you will either want all or none applied. When False, if an error occurs while importing an edit on the server, the operation skips the edit and continues. that were skipped are returned in the edits results with information describing why the edits were skipped. This is the default value.
close_replica	Optional Boolean. Indicates whether to unregister the replica upon completion. The default value is False. If True, the replica will be unregistered when operation completes. If False, the replica can continue to be synchronized.
out_path	Opitonal 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)

unregisters 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 a FeatureLayerCollection. This class is not created by users directly. An instance of this class, called ‘manager’, is available as a property of the FeatureLayerCollection object.

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

add_to_definition(json_dict, future=False)

The add_to_definition operation supports adding a definition property to a hosted feature layer collection service. The result of this operation is a response indicating success or failure with error code and description.

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

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

Returns

JSON message as dictionary when future=False else If future = True, then the result is a Future object. Call result() to get the response.

create_view(name, spatial_reference=None, extent=None, allow_schema_changes=True, updateable=True, capabilities='Query', view_layers=None, view_tables=None, *, description=None, tags=None, snippet=None, overwrite=None, set_item_id=None, preserve_layer_ids=False, visible_fields=None, query=None)

Creates a view of an existing feature service. You can create a view, if you need a different view of the data represented by a hosted feature layer, for example, you want to apply different editor settings, apply different styles or filters, define which features or fields are available, or share the data to different groups than the 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 a view of the data in the hosted feature layer, which means updates made to the data appear in the hosted feature layer and all of its hosted feature layer views. However, since the view is a separate layer, you can change properties 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-only feature 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 a service’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 FeatureLayerCollection that you want in the view.
view_tables	Optional list. Specify list of tables present in the FeatureLayerCollection that 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, you must overwrite the hosted feature layer from which it was created. See the ArcGIS Online Overwrite hosted feature layers or the ArcGIS Enterprise Overwrite hosted feature layers documentation for requirements and considerations for overwriting. See also Considerations when creating hosted feature layer views for additional criteria for overwriting.
set_item_id	Optional String. If set, the ItemId is defined by the user, not the system.
preserve_layer_ids	Optional Boolean. Preserves the layer’s id on it’s definition when True. The default is False.
visible_fields	Optional list[str] or None. A list of visible fields to display.
query	Optional String. A SQL statement that defines the view.

Returns

Returns the newly created Item for the view.

delete_from_definition(json_dict, future=False)

The delete_from_definition operation supports deleting a definition property from a hosted feature layer collection service. The result of this operation is a response indicating success or failure with error code and description. 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 format can be derived from the properties property. For layer level modifications, run updates on each individual feature service layer object.
future	Optional boolean. If True, a future object will be returns and the process will not wait for the task to complete. The default is False, which means wait for results.

Returns

JSON message as dictionary when future=False else If future = True, then the result is a Future object. Call result() to get the response.

classmethod fromitem(item)

The fromitem method is used to create a FeatureLayerCollection from a Item class.

Parameter	Description
item	A required Item object. The item needed to convert to a FeatureLayerCollection object.

Returns

A FeatureLayerCollection object.

property generate_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, name=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.

property layers

Returns a list of FeatureLayerManager to work with FeatureLayers

Returns

List[FeatureLayerManager]

overwrite(data_file)

Overwrite all the features and layers in a hosted feature layer collection service. This operation removes all 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 this layer.

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

Returns

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

property properties

The properties property retrieves and set properties of this object.

refresh()

refreshes a feature layer collection

swap_view(index, new_source, future=False)

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	Requred FeatureLayer or Table. The layer to replace the existing source with.
future	Optional Bool. When True, a Future object will be returned else a JSON object.

Returns

dict | concurrent.futures.Future

property tables

Returns a list of FeatureLayerManager to work with tables

Returns

List[FeatureLayerManager]

update_definition(json_dict, future=False)

The update_definition operation supports updating a definition property in a hosted feature layer collection service. The result of this operation is a response indicating success or failure with error code and description.

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

Returns

JSON message as dictionary when future=False when future=True, Future object is returned. Call result() to get the response.

property webhook_manager

Returns

WebHookServiceManager

Allows updating the definition (if access permits) of a FeatureLayer. This class is not created by users directly. An instance of this class, called ‘manager’, is available as a property of the FeatureLayer object, if the layer can be managed by the user. Users call methods on this ‘manager’ object to manage the feature layer.

add_to_definition(json_dict, future=False)

The addToDefinition operation supports adding a definition property to a hosted feature layer.

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

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

Returns

JSON message as dictionary indicating ‘success’ or ‘error’. If future = True, then the result is a Future object. Call result() to get the response.

property contingent_values

returns the contingent values for the service endpoint

delete_from_definition(json_dict, future=False)

The deleteFromDefinition operation supports deleting a definition property from a hosted feature layer. The result of this operation is a response indicating success or failure with error code and description. 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 format can be derived from the properties property. For layer level modifications, run updates on each individual feature service layer object. Only include the items you want to remove from the FeatureService or layer.
future	Optional, If True, a future object will be returns and the process will not wait for the task to complete. The default is False, which means wait for results.

Returns

JSON Message as dictionary indicating ‘success’ or ‘error’. If future = True, then the result is a Future object. Call result() to get the response.

property field_groups

returns the field groups for the service endpoint

classmethod fromitem(item, layer_id=0)

Creates a FeatureLayerManager object from a GIS Item.

Parameter	Description
item	Required of type FeatureService that represents a FeatureLayerCollection .
layer_id	Required int. Id of the layer in the FeatureLayerCollection

Returns

FeatureLayer created from the layer provided.

property properties

The properties property retrieves and set properties of this object.

refresh()

refreshes a service

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

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

Note

The truncate method is restricted to layers that:

• do not serve as the origin in a relationship with other layers

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

• do not have sync 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. The default is False. It is recommended to set asynchronous=True for large datasets.
wait	Optional boolean. If True, then wait to pause the process until asynchronous operation is completed. Default is True.

Returns

JSON Message as dictionary indicating success or error

update_definition(json_dict, future=False)

The update_definition operation supports updating a definition property in a hosted feature layer. The result of this operation is a response indicating success or failure with error code and description.

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

Returns

JSON Message as dictionary indicating ‘success’ or ‘error’. If future = True, then the result is a Future object. Call result() to get the response.

VersionManager allows users to manage the branch versioning for FeatureLayerCollection services. The Version Management Service is responsible for exposing the management capabilities necessary to support feature services that work with branch versioned datasets.

See the Version Management Service for more information

property all

returns all visible versions on a service

create(name, permission='public', description='')

Create the named version off of DEFAULT. The version is associated with the specified feature service. During creation, the description and 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. The default 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, mode=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 specific state of edit or read. If None is provided (default) the version is created without entering a mode. Values: edit - starts editing mode read - starts reading mode None - no mode is started. This is default.

property locks

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

Returns

List of locked versions

property properties

returns the service properties

purge(version, owner=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=None, show_hidden=False)

For the specified feature service, return the info of all versions that the client has access to. If the client is the service owner (the user that published the service), all versions are accessible and 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 be returned.

Returns

Dictionary indication ‘success’ or ‘error’

A Version represents a single branch in the version tree.

alter(owner=None, version=None, description=None, permission=None)

The alter 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()

The conflicts operation allows you to view the conflicts by layer and type (update-update, update-delete, delete-update) that were identified during the last Reconcile operation. The features that are 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)

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

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)

The differences operation allows you to view differences between the current version and the default version. The two versions can be 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 is objectIds. Values : “objectIds” | “features”
moment	Required String. Moment used to compare current version with default.
from_moment	Optional string. Time epoch value in milliseconds specifying the time from which to obtain the differences between this value and the specified moment argument value. Note By default, if this parameter is not specified, the differences operation returns the edits (inserts, updates, and deletes) at the specified value of the moment 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 should be returned. If not specified, the differences for all layers will be returned.
future	Optional boolean. If True, the method runs as an asynchronous job returning a _URL_ value to inspect the status of the job. The default value is False.

Returns

Dictionary with a differences key indicating the various inserts, updates, or deletes for each layer.

edit(layer, adds=None, updates=None, deletes=None, use_global_ids=False, rollback_on_failure=True)

The edit operation allows users to apply changes to the current version. The edit session must be in the mode of edit or an exception will be raised.

Inputs	Description
layer	Required FeatureLayer . The layer to perform the edit on.
adds	Optional FeatureSet /List. The array of features to be added.
updates	Optional FeatureSet /List. The array of features to be updated.
deletes	Optional FeatureSet /List. String of OIDs to remove from service
use_global_ids	Optional boolean. Instead of referencing the default Object ID field, the service will look at a GUID field to track changes. This means the GUIDs will be passed instead of OIDs for delete, update or add features.
rollback_on_failure	Optional boolean. Optional parameter to specify if the edits should be applied only if all submitted edits succeed. If false, the server will apply the 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.

Returns

Dictionary

inspect(conflicts, inspect_all=False, set_inspected=False)

The inspect operation allows the client to annotate conflicts from the conflict set that was obtained during the last reconcile operation. Users can mark the conflicts as being inspected; additionally, a description or note can be associated with the conflict.

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 conflicts as being inspected.
set_inspected	Optional Boolean. If True, the examined values will be set to inspected. If inspect_all is True, this parameter is ignored.

Returns

Boolean. True if successful else False.

property layers

returns the layers in the FeatureLayerCollection

property mode

The mode allows version editors to start and stop edit, read, or view mode.

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

property parcel_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 their branch to the default version. The client can only post changes if the branch version has not been modified since the last reconcile. If the default version has been modified in the interim, the client will have to reconcile again before posting.

Parameter	Description
rows	Optional List of dictionaries representing the features or objects for posting a subset of edits in the current version. The objectIds specified must be edits contained within the current version, which can be obtained from the differences() method. The posted edits will no longer exist in the current version, another reconcile() is necessary to 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 asynchronous job. The results are returned as a Url pointing to a location that indicates the status of the job.

Returns

Boolean. True or a job URL if successful, else False.

property properties

returns the service properties

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

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

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

Returns

Boolean.

If future = True, then the result is a Future object. Call result() to get the response.

restore(rows)

The restore method allows users to restore rows from a common ancestor version. This method is intended to be used when a DeleteUpdate 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

property save_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. When start_reading is enabled, it will prevent other users from editing or reconciling the version.

Returns

Boolean. True if successful else False.

stop_editing(save=None)

Starts an edit session for the current user.

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

Returns

Boolean. True if successful else False.

stop_reading()

Stops and releases a reading session.

Returns

Boolean. True if successful else False.

property tables

returns the tables in the FeatureLayerCollection

property utility

provides access to the utility service manager

property validation

Provides access to a validation manager.

Returns

ValidationManager

The Parcel Fabric Server is responsible for exposing parcel management capabilities to support a variety of workflows from different clients and systems.

analyze_least_squares_adjustment(analysis_type='CONSISTENCY_CHECK', convergence_tolerance=0.05, parcel_features=None, future=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 the input parcels. A least-squares adjustment is a mathematical procedure that uses statistical analysis to estimate the most likely coordinates for connected points in a measurement network.

Use apply_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 on parcel lines for inconsistencies and mistakes. Fixed or weighted control points will not be used by the adjustment. WEIGHTED_LEAST_SQUARES - A weighted least-squares adjustment will be run to compute updated coordinates for parcel points. The parcels being adjusted should connect to at least two fixed or 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 least squares adjustment is run repeatedly (in iterations) until the solution converges. The solution is considered converged when maximum coordinate shift encountered becomes less than the specified convergence tolerance. 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. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Boolean. True if successful else False

apply_least_squares_adjustment(movement_tolerance=0.05, update_attributes=True, future=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 stored in the AdjustmentLines and AdjustmentPoints feature classes are applied to the corresponding parcel line, connection line, and parcel fabric point feature classes.

Use analyze_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 between the adjustment point and the parcel fabric point is greater than the specified tolerance, the parcel fabric point 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 with statistical metadata. The XY Uncertainty, Error Ellipse Semi Major, Error Ellipse Semi Minor, and Error Ellipse Direction fields will be updated with the values stored in the same fields in the AdjustmentPoints feature class. The default is True
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Boolean. True if successful else False

assign_to_record(features, record, write_attribute, moment=None, future=False)

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

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 specified parcel features.
write_attribute	Required String. Represents the record field to update on the parcel features. Either the Created By Record or Retired By Record field is to be updated with the global ID of the assigned record. Allowed Values: CreatedByRecord or RetiredByRecord
moment	Optional Integer. This should only be specified by the client when they do not want to use the current moment
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Boolean. True if successful otherwise False

build(extent=None, moment=None, return_errors=False, record=None, future=False)

A build will fix known parcel fabric errors.

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

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

Parameter	Description
extent	Optional Envelope . 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 when they do not want to use the current moment
return_errors	Optional Boolean. If True, a verbose response will be given if errors occured. The default is False. Deprecated
record	Optional String. Represents the record identifier (guid). If a record guid is provided, only parcels associated to the record are built, regardless of the build extent.
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Boolean. True if successful else False

change_type(parcels, target_type, parcel_subtype=0, moment=None, future=False)

Changes a set of parcels to a new parcel type. It creates new polygons and lines and deletes them from the source type. This is used when a parcel was associated in the wrong parcel type subtype and/or when creating multiple parcels as part of a build process. Example: when lot parcels are created as part of a subdivision, the road 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 meaning no subtype required.
moment	Optional String. This parameter represents the session moment (the default is the version current moment). This should only be specified by the client when they do not want to use the current moment.
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Boolean. True if successful else False

clip(parent_parcels, clip_record=None, clipping_parcels=None, geometry=None, moment=None, option=None, area_unit=None, future=False)

Clip cuts a new child parcel into existing parent parcels. Commonly it retires the parent parcel(s) it cuts into to generate a reminder child parcel. This type of split is often part of a parcel split metes 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 clip into the parent parcels. Parcel lineage is created if the child ‘clipping_parcels’ and the parcels being clipped are of the same parcel type. Syntax clipping_parcels= <"id" : "parcel guid", "layerId": "<layer id>"...> # Example: >>> clipping_parcels = [{"id":"{D01D3F47-5FE2-4E39-8C07-E356B46DBC78}","layerId":"16"}] Note Either clipping_parcels or geometry 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 Either clipping_parcels or geometry is required.
moment	Optional String. This should only be specified by the client when they 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 stated areas of the clipped parcels. The stated area of the clipped parcels will be calculated if the stated areas exist on the parent parcels being clipped.
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Dictionary indicating ‘success’ or ‘error’

copy_lines_to_parcel_type(parent_parcels, record, target_type, moment=None, mark_historic=False, use_source_attributes=False, attribute_overrides=None, use_polygon_attributes=False, parcel_subtype=None, future=False)

Copy lines to parcel type is used when the construction of the child parcel is based on parent parcel geometry. It creates a copy of the parent parcels lines that the user can modify (insert, delete, update) before they build the child parcels. If the source parcel 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 legal record.
target_type	Required String. The target parcel layer to which the lines will be copied to.
moment	Optional String. This parameter represents the session moment (the default is the version current moment). This should only be specified by the client when they do not want to use the current moment.
mark_historic	Optional Boolean. Mark the parent parcels historic. The default is False.
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 new child parcel lines when it is set to True. The default is False.
use_polygon_attributes	Optional Boolean. Parameter representing whether to preserve and transfer attributes of the parent parcels to the generated seeds.
attribute_overrides	Optional Dictionary. To set fields on the child parcel lines with a specific 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. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Dictionary indicating ‘success’ or ‘error’

create_seeds(record, moment=None, extent=None, future=False)

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

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

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

Parameter	Description
record	Required String. A GUID representing the record that will be assigned to the features set as current or historic.
moment	Optional String. This parameter represents the session moment (the default is the version current moment). This should only be specified by the client when they do not want to use the current moment.
extent	Optional Dict/ Envelope . The envelope of the extent in which to create seeds.
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Dictionary indicating ‘success’ or ‘error’

delete(parcels, moment=None, future=False)

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

Parameter	Description
parcels	Required List. The parcels to erase.
moment	Optional String. This parameter represents the session moment (the default is the version current moment). This should only be specified by the client when they do not want to use the current moment.
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Dictionary indicating ‘success’ or ‘error’

divide(divide_parcel_guid, divide_parcel_type, divide_record, divide_option, divide_number_of_parts, divide_part_area, divide_line_bearing, divide_left_side, divide_distribute_remainder, default_area_unit=None, divide_cogo_line_bearing=None, divide_associated_lines=False, future=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 identifier guid of the parcel being divided.
divide_parcel_type	Required Integer. Parameter representing the parcel type layer ID in which the new, divided parcels will be created.
divide_record	Required String. Parameter for the unique identifier guid of the record 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 will be 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. A default value of 0 will be applied.
divide_line_bearing	Required Float. The direction (in decimal degrees) of the line used to divide the parcel.
divide_left_side	Required Boolean. Parameter indicating if area being divided is starting from the leftmost edge of the parcel. Any remainder area will be to the right of the divided parts. If False, the area being divided starts from the rightmost edge of the parcel and any remainder area will be to the left of the divided parts. This parameter is required for the EqualArea and EqualWidth divide options. Note This value is ignored when dividing by proportional area. A default value of False will be applied.
divide_distribute_remainder	Required Boolean. Indicates whether to distribute or merge the remainder area after the divide is performed. This parameter is used for the EqualArea and EqualWidth divide options. Note This value is ignored when dividing by proportional area. A default value of False will be applied.
default_area_unit	Required Integer. The units in which area will be stored. The parameter is specified as a domain code from the PF_AreaUnits parcel fabric domain. #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 field of 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 is False.
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Dictionary indicating ‘success’ or ‘error’

duplicate(parcels, parcel_type, record, parcel_subtype=None, repeat_count=None, update_field=None, start_value=None, increment_value=None, moment=None, future=False)

duplicate allows for the cloning of parcels from a specific record.

Parcels can be duplicated in the following ways:

• Duplicate to a different parcel type.

• Duplicate to a different subtype in the same parcel type.

• Duplicate to a different subtype in a different parcel type.

Similarly, parcel seeds can be duplicated to subtypes and different parcel types.

Parameter	Description
parcels	Required List. A list of parcels to duplicate. Syntax >>>> parcels=[ {"id":"<parcelguid>", "layerId":"16" }, {...} ]
parcel_type	Required Integer. The target parcel type.
record	Required String. A GUID representing the record that will be assigned to the features set as current or historic.
parcel_subtype	Optional Integer. The target parcel subtype. The default is 0.
repeat_count	Optional Integer. How many times to duplicate the target parcels
update_field	Optional String. Which incrementable field to update on the target
start_value	Optional Integer. What value to start on when incrementing
increment_value	Optional Integer. How many steps to increment
moment	Optional String. This parameter represents the session moment (the default is the version current moment). This should only be specified by the client when they do not want to use the current moment.
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Dictionary indicating ‘success’ or ‘error’

property layer

returns the Parcel Layer ( FeatureLayer object or None ) for the service

merge(parent_parcels, target_parcel_type, attribute_overrides=None, child_name=None, default_area_unit=None, merge_record=None, merge_into=None, moment=None, future=False)

Merge combines 2 or more parent parcels into onenew child parcel. Merge sums up legal areas of parent parcels to the new child parcel legal area (using default area units as dictated by client). The child parcel lines arecomposed from the outer boundaries of the parent parcels. Merge can create multipart parcels as well as proportion lines (partial overlap of parent parcels). Record footprint is updated to match the child parcel.

Parameter	Description
parent_parcels	Required String. It is the parcel(guid)+layer(name) identifiers to merge.
target_parcel_type	Required String. Layer where parcel is merged to. History is created when parents and child are of the same parcel type
attribute_overrides	Optional List. A list of attributes to set on the child parcel, if they exist. Pairs of field name and value. Syntax >>> attribute_overrides = [ { "type": "PropertySet", "propertySetItems": [ <field name>, <field value> ] } ] Note To set subtype, include subtype value in this list.
child_name	Optional String. A descript of the child layer. DEPRECATED
default_area_unit	Optional String. The area units of the child parcel.
merge_record	Optional String. Record identifier (guid). If missing, no history is created.
merge_into	Optional String. A parcel identifier (guid). Invalid to have a record id.
moment	Optional String. This parameter represents the session moment (the default is the version current moment). This should only be specified by the client when they do not want to use the current moment.
area_unit	Optional Integer. Represents the default area units to be used when calculating the stated area of the merged parcel. The stated area of the merged parcel will be calculated if the stated areas exist on the parcels being merged.
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Dictionary indicating ‘success’ or ‘error’

property properties

returns the properties of the service

reassign_features_to_record(source_record, target_record, delete_source_record, future=False)

Reassigns all parcel features in the specified source record to the specified target record. The source record will become empty and will be associated to no parcel features. The record polygon of the target record will be updated to match the cumulative geometry of all the parcels associated to it.

The Created By Record or Retired By Record attribute field of the parcel features is updated with the global ID of the assigned record.

Parameter	Description
source_record	Required String. GlobalID representing the record containing the parcel features to be reassigned. Syntax: source_record=<guid>
target_record	Required String. GlobalID representing the target record to which the parcel features will be reassigned. Syntax target_record=<guid>
delete_source_record	Required Bool. Parameter indicating whether to delete the original source record.
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Boolean

reconstruct_from_seeds(extent, future=False)

This operation constructs parcels from seeds enclosed by parcel lines in the specified extent. The tool reconstructs parcels regardless of the parcel lines associations with records.

Parameter	Description
extent	Parameter representing the envelope of the extent to reconstruct seeds. Seeds that lie within the specified extent will be reconstructed into parcels. Syntax >>> extent={ "xmin":X min, "ymin": y min, "xmax": x max, "ymax": y max, "spatialReference": {"wkid": <wkid_value>} }
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Dictionary indicating ‘success’ or ‘error’

set_line_label_position(parcel_line_features, future=False)

The set_line_label_position() sets the label position of the line’s COGO dimension to the left of the parcel line, to the right of the parcel line, or centered over the parcel line.

Parameter	Description
parcel_line_features	Required List. Parameter representing the input parcel line layers with label positions that will be updated. >>> parcel_line_features=[{"id":"<guid>", "layerId":"<layerID>"}, {...}]
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Dictionary indicating ‘success’ or ‘error’ with a list of edited features

transfer_parcel(transfer_parcel_feature, target_parcel_features, record, default_area_unit, source_parcel_features=None, future=False)

The transfer_parcel() method supports workflows for transferring a piece of land between parcels.

Parameter	Description
transfer_parcel_feature	Required Dict. Parameter representing the parcel to be transferred. Only one parcel can be specified as the transfer parcel. # Example Usage: >>> transfer_parcel_feature={"id":"<guid>","layerId":"<layerID>"}
target_parcel_features	Required List. Parameter representing the target parcels to which land will be transferred. These parcels will be merged with the transfer parcel and will become larger. # Example Usage: >>> target_parcel_features=[{"id":"<guid>","layerId":"<layerID>"},{...}]
record	Required String. Parameter for the unique identifier (GUID) of the record being used for the transfer
default_area_unit	Required Integer. The units in which area will be stored. The parameter is specified as a domain code from the PF_AreaUnits parcel fabric domain. #Example Usage: #Square feet >>> default_area_unit=109405 #Square meters >>> default_area_unit=109404
source_parcel_features	Optional List. Parameter representing the source parcels from which land will be transferred. These parcels will be clipped and will become smaller. # Example Usage: >>> source_parcel_features=[{"id":"<guid>","layerId":"<layerID>"},{...}]
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Dictionary indicating ‘success’ or ‘error’ with a list of edited features

update_history(features, record, moment=None, set_as_historic=False, future=False)

Sets the specified parcel features to current or historic using the specified record. If setting current parcels as historic, the Retired By Record field of the features is updated with the Global ID of the specified record. If setting historic parcels as current, the Created By Record field of the features is updated with the Global ID of the specified record.

Parameter	Description
features	Required List. The parcel features to be set as historic or current. Can be parcels, parcel polygons, parcel points, and parcel lines. Syntax >>> features=[ {"id":"<guid>", "layerId":"<layerID>"}, {...} ]
record	Required String. A GUID representing the record that will be assigned to the features set as current or historic.
moment	Optional String. This parameter represents the session moment (the default is the version current moment). This should only be specified by the client when they do not want to use the current moment.
set_as_historic	Optional Boolean. Boolean parameter representing whether to set the features as historic (True). If False, features will be set as current.
future	Optional boolean. If True, the request is processed as an asynchronous job and a URL is returned that points a location displaying the status of the job. The default is False.

Returns

Dictionary indicating ‘success’ or ‘error’

The Topographic Production Service resource represents a topographic production server object extension (SOE). It is the entry point for all functionality related to creating topographic products in ArcGIS Server. This resource provides information about the service and enables the topographic production server capabilities on a map service. You can also view child resources and operations defined by the SOE.

add_product(product_definition, raster=None, ancillary_layers=None)

The add_product operation adds a definition of a map product to the Topographic Production Service resource that can be used to generate a map

Parameter	Description
product_definition	Required dictionary. The definition of the map product. See Parameters
raster	Optional string. The path to the raster on disk (server path).
ancillary_layers	Optional list of dictionaries. Additional layers to include in the final product. Syntax: ``` [{ “layer”: “url of the layer”, “featureClass”: “name of the feature class to extract to”, “map”: “name of the map the layer will be inserted into”, “layerIndex”: “insertion index of the layer” }, … Note This parameter supports services located in the same portal site as the server object extension (SOE) or services that are publicly available. The featureClass, map, and layerIndex properties in the array are optional. If the dataset is identifiable from the feature service, it is not necessary to provide the featureClass property. The default values are 0 for layerIndex and BaseMap for map.

Returns

True if succeeded and False if failed.

calculate_extent(name, version, area_interest_layer, input_geometry, out_sr)

The calculate_extent operation calculates a custom area of interest (AOI) for a given product and version. The result can be specified as the value for the customAoi parameter of the generateProduct operation.

Parameter	Description
name	Required string. The name of the product.
version	Required string. The version of the product to generate.
area_interest_layer	Required string. The url of the layer defining the product’s area of interest.
input_geometry	Required dictionary. A geometry defining the center of the custom extent. A point geometry.
out_sr	Required string. The coordinate system for the extent that is returned.

Returns

True if success and False otherwise.

generate_product(name, version, area_interest_layer, area_interest_feature_id, output_type, custom_area_interest=None, layer_exclusion=None, ancillary_layers=None, output_settings=None)

The generate_product operation automates the process of producing a layout or map based on an existing map product definition.

Parameter	Description
name	Required string. The name of the product. This parameter’s value must match one of the product names from “https://<topographicProductionServer-url>/products”.
version	Required list of dictionaries or string. The version of the product to generate. The product version name must match a name value listed in the products endpoint. Starting at Enterprise 11.2, the following properties can be included: * extractionDatabase - Overwrite the extractionDatabase value at the map product level. * operationOverrides - Overwrite the values in teh parameters key-value pairs with the specified IDS. * excludeOperations - Exclude the specified IDs. The following example includes three product versions: TRD_4_5, TRD_4_5_1, and TRD_4_6. The TRD_4_5 product version shows operationOverrides and excludedOperations available at Enterprise11.2: [ { "name": "TRD_4_5", "template": "MTM50_Layout.pagx" "extractionDatabase": "", "operationOverrides": [ { "id": "26C62049-A11F-4D5B-BC80-00CF3597555C", "parameters": [ { "name": "input_map", "value": "Map" }, ] }, "excludedOperations": [ "45B62049-A11F-4D5B-BC80-00CF3597555C", ... ] }, { "name": "TRD_4_5_1", "template": "MTM50_Layout.pagx" }, { "name": "TRD_4_6", "template": "MTM50_Layout.pagx" } ]
area_interest_layer	Required string. The url of the layer defining the product’s area of interest.
area_interest_feature_id	Required string. The Object ID of the area of interest feature in the area_interest_layer. Note If you use the optional custom_area_interest parameter, then this parameter is ignored.
output_type	Required string value that specifies the output type. Supported values include “aprx” , “ppkx” , “pagx” , “pdf” , and “tiff” . Additional files can be formatted using the outputFiles parameter. Use JSON to customize the output type of a file. Supported outputFiles values include Geodatabase , Raster , ProductTemplate , and Project . Syntax: { "outputType": "pdf", "outputFiles": [ "Geodatabase", "Raster", "ProductTemplate", "Project" ] } Note By default, the APRX and PAGX output types are exported as ZIP files that include a file geodatabase.
custom_area_interest	Optional list dictionary. The features defining the product’s area of interest. One feature is allowed at the current release.
layer_exclusion	Optional list of strings. The list of layer urls to exclude from the product.
ancillary_layers	Optional list of dictionaries. Additional layers to include in the final product. Syntax: ``` [{ “layer”: “url of the layer”, “featureClass”: “name of the feature class to extract to”, “map”: “name of the map the layer will be inserted into”, “layerIndex”: “insertion index of the layer” }, … Ancillary layers are added as feature service layers of the final product and don’t extract data to the local geodatabase. Note This parameter supports services located in the same portal site as the server object extension (SOE) or services that are publicly available. The featureClass, map, and layerIndex properties in the array are optional. If the dataset is identifiable from the feature service, it is not necessary to provide the featureClass property. The default values are 0 for layerIndex and BaseMap for map.
output_settings	Optional dictionary. The predefined settings for a PDF or TIFF output type. Allowed inputs can either be the name of a preset file included with the ArcGIS Production Mapping, the ArcGIS Defense Mapping Enterprise product files, or a JSON data structure that identifies the output settings in one of the formats detailed here: Properties This parameter was added at Enterprise11.0.

Returns

A dictionary with the jobId and statusUrl.

jobs_manager()

Retrieve the Topographic Production Job Manager class. With this manager you can retrieve all jobs, a single job, query or cancel a job.

Returns

TopographicProductionJobManager

product(name, include_def=True)

The product operation retrieves a single product from the products that a Topographic Production Service resource supports.

Parameter	Description
name	Required string. The name of the product.
include_def	Optional bool. Specifies whether the full json definition of the map product is included.

products(include_def=True)

The products operation retrieves the products that a Topographic Production Service resource supports.

Parameter	Description
include_def	Optional bool. Specifies whether the full json definition of the map product is included.

Returns

The products that are supported as a dictionary.

property properties

returns the properties for the service

remove_product(name)

The remove_product operation removes a product from the Topographic Production service and returns a standard REST success or error message.

Parameter	Description
name	Required string. The name of the product.

Returns

True if success, else False.

update_product(name, description=None, enabled=None, sheet_id_field=None, raster=None, versions=None, ancillary_layers=None)

The update_product operation updates properties of a product.

Parameter	Description
name	Required string. The name of the product.
description	Optional string. The new description of the product.
enabled	Optional bool. Enables or disables the product. If a product is disabled, the generate_product operation returns an error for that product.
sheet_id_field	Optional string. Updates the sheet ID field.
raster	Optional string. The path to a raster on disk (server path).
versions	Optional dict. Indicates the type of operation and versions. There are two formats. If the operation is add or update: ``` { “operation”: “add | update”, “versions”: [ { “name”:”name of version”, “template”: “name of template” ] If the operation is remove: ``` { “operation”: “remove”, “versions”: [ “name of version 1”, “name of version 2”, … ] } Starting at ArcGIS Enterprise11.2, additional properties can be applied: extractionDatabase - Overwrites the extractionDatabase value at the map product level. operationOverrides - Overwrites the parameters key-value pairs on an existing operation with the provided ID. The ID must match an existing operation. excludedOperations - The operations pertaining to the IDs provided are excluded. The following example uses operationOverrides to identify an operation and override its parameter key-value pairs with the ones provided and excludedOperations to identify operations that will be excluded: [ { "name": "TRD_4_5", "template": "MTM50_Layout.pagx" "extractionDatabase": "", "operationOverrides": [ { "id": "26C62049-A11F-4D5B-BC80-00CF3597555C", "parameters": [ { "name": "input_map", "value": "Map" }, ] }, "excludedOperations": [ "45B62049-A11F-4D5B-BC80-00CF3597555C", ... ] } ]
ancillary_layers	Optional dictionary. Indicates the product layers. Use the following format to add or update layers: { "operation" : "<add | update>", "layers": [ { "layer": "<url of layer>", "featureClass": "<name of feature class to extract to>", "map": "<name of map layer will be inserted into>", "layerIndex": "<insertion index of layer>" }, ... ] } Use the following format to remove the layer:

Returns

The product name and whether the operation was a success(True) or a failure (false)

cancel_job(job_id)

The cancel operation cancels a job submitted through the generate_product REST operation. It returns a standard REST success or error message.

Parameter	Description
job_id	Required string. The unique job id to cancel.

Returns

Success (true) or Failure (false)

job(job_id, msg_level=None)

The job operation tracks the status of a job executed by the generate_product REST operation and returns the status, start date, last modified date, and messages of the job.

Parameter	Description
job_id	Required string. The unique job id to see.
msg_level	Optional string. The message level associated with the job. Values: “info” | “warn” | “error” Note Regardless of the msgLevel value, any errors that a job contains are included in the messages array of the response by default.

Returns

A Json response with syntax:

``` {

”status”: <untranslated string representing general status of the job>, “statusCode”: <code representing specific status of the job>, “submissionTime”: <time and date of the job submission in UTC and ISO 8601 format YYYY-MM-DDThh:mm:ssZ>, “lastUpdatedTime”: <time and date of the last job update in UTC and ISO 8601 format YYYY-MM-DDThh:mm:ssZ>, “percentComplete”: <percent of the job completed>, “aoiLayer”: <URL of AOI layer>, “aoiFeatureId”: <AOI feature ID>, “outputUrl”: <URL of output>, “user”: <username>, “jobId”: <job identifier>, “productName”: <name of the product>, “productVersion”: <version of the product>, “outputType”: <type/format of the output>, “messages”: { <informative | error | warning> }

jobs()

Retrieve all the jobs for the service.

query_job(status=None, start_date=None, end_date=None, msg_level=None)

The query operation retrieves the status of jobs executed by the generate_product REST operation and returns the status, start date, last modified date, and messages for a set of jobs.

Parameter	Description
status	Optional int. Retrieves all the jobs with a particular status. `Values: New—0 Submitted—1 Waiting—2 Executing—3 Succeeded—4 Failed—5 TimedOut—6 Canceling—7 Canceled—8 Deleting—9 Deleted—10`
start_date	Optional datetime. Retrieves all the jobs that started on or after the start date and time specified. The date and time should be UTC and in ISO 8601 format. If time is not specified, then midnight is used in the following format: 00:00:00.
end_date	Optional datetime. Retrieves all the jobs that ended on or after the end date and time specified. The date and time should be UTC and in ISO 8601 format. If time is not specified, then 23:59:59 is used.
msg_level	Optional string. The message level associated with the job. Values: “info” | “warn” | “error” Note Regardless of the msgLevel value, any errors that a job contains are included in the messages array of the response by default.

allow_indeterminate_flow: bool | None = None

condition_barriers: list[dict] | None = None

domain_network_name: str

filter_barriers: list[dict] | None = None

filter_bitset_network_attribute_name: str | None = None

filter_function_barriers: list[dict] | None = None

filter_scope: arcgis.features._trace_configuration.FilterScopeEnum | str | None = 'junctionsAndEdges'

classmethod from_config(config)

Loads the Trace Configurations from a Configuration

function_barriers: list[dict] | None = None

functions: list[dict] | None = None

ignore_barriers_at_starting_points: bool = False

include_barriers: bool = True

include_containers: bool = False

include_content: bool = False

include_isolated: bool = False

include_structures: bool = False

include_up_to_first_spatial_container: bool = False

nearest_neighbor: dict | None = None

output_conditions: list[dict] | None = None

output_filters: list[dict] | None = None

propagators: list[dict] | None = None

shortest_path_network_attribute_name: str | None = None

subnetwork_name: str | None = None

synthesize_geometry: bool = False

target_tier_name: str | None = None

tier_name: str

to_dict()

traversability_scope: arcgis.features._trace_configuration.TraversabilityScopeEnum | str | None = 'junctionsAndEdges'

use_digitized_direction: bool = False

validate_consistency: bool = True

validate_locatability: bool = False

The traceConfigurations resource provides access to all trace configuration operations for a network service. It is returned as an array of named trace configurations with the creator, name, and global ID for each.

The TraceConfigurationsManager allows methods to be done on a trace configuration.

alter(global_id, name=None, description=None, trace_type='connected', trace_config=None, result_types=None, tags=None)

The alter operation provides the ability to alter a single named trace configuration. A named trace configuration can only be altered by an administrator or the creator of the configuration. For example, you can update an existing trace configuration to accommodate changes in the network or address incorrectly set parameters without the need to delete and re-create a trace configuration. This enables existing map services to continue use of the named trace configuration without requiring the map to be republished.

Parameter	Description
global_id	Required String. Specifying the global ID of the named trace configuration to alter.
name	Optional String. The altered name of the trace configuration.
description	Optional String. Specify the altered description of the trace configuration.
trace_type	Optional String. Specify the core algorithm that will be used to analyze the network. Trace types can be configured using the trace_config parameter. Values: “connected” | “subnetwork” | “upstream” | “subnetworkController” | “downstream” | “loops” | “shortenPath” | “isolation”
trace_config	Optional Dictionary or instance of TraceConfiguration class. Specify the collection of altered trace configuration properties. See: Properties
result_types	Optional List of Dictionary. Specify the altered types of results to return. [{ "type" : "elements" | "aggregatedGeometry" | "connectivity" | "features" | "associations", "includeGeometry" : true | false, "includePropagatedValues": true | false, "networkAttributeNames" :["attribute1Name","attribute2Name",...], "diagramTemplateName": <value>, "resultTypeFields":[{"networkSourceId":<int>,"fieldname":<value>},...] },...]
tags	Optional List of String(s). Specify the altered user-provided tags.

Returns

A dictionary with key “success” indicating True or False.

create(name, trace_type, trace_config, description=None, result_types=None, tags=None)

The create operation on the traceConfigurations resource provides the ability to create a single named trace configuration. Named trace configurations store the properties of a complex trace in a utility network and can be shared through a map service consumed by a web map or field app. Multiple parameters and properties are provided with the create operation that support the analytic workflows associated with the trace operation.

If your trace configuration already exists, use the query method to find it.

Parameter	Description
name	Required String. The altered name of the trace configuration.
trace_type	Required String. Specify the core algorithm that will be used to analyze the network. Trace types can be configured using the trace_config parameter. Values: “connected” | “subnetwork” | “upstream” | “subnetworkController” | “downstream” | “loops” | “shortenPath” | “isolation”
trace_config	Required Dictionary or TraceConfiguration object. Specify the collection of altered trace configuration properties. See: Properties
description	Optional String. Specify the altered description of the trace configuration.
result_types	Optional List of Dictionary. Specify the altered types of results to return. [{ "type" : "elements" | "aggregatedGeometry" | "connectivity" | "features" | "associations", "includeGeometry" : true | false, "includePropagatedValues": true | false, "networkAttributeNames" :["attribute1Name","attribute2Name",...], "diagramTemplateName": <value>, "resultTypeFields":[{"networkSourceId":<int>,"fieldname":<value>},...] },...]
tags	Optional List of String(s). Specify the altered user-provided tags.

Returns

A dictionary with key “success” indicating True or False.

delete(global_ids)

The delete operation provides the ability to delete one or more named trace configurations in a utility network. A named trace configuration can only be deleted by an administrator or its creator.

Returns

A dictionary with key “success” indicating True or False.

list()

List of all trace configurations in a service.

Returns

A dictionary with two keys: {“traceConfigurations”: list, “success”: bool}

query(global_ids=None, creators=None, tags=None, names=None, as_trace_configuration_class=False)

The query operation returns all properties from one or more named trace configurations in a utility network.

Parameter	Description
global_ids	Optional list of strings. Specify the global IDs of the named trace configs to be queried.
creators	Optional list of strings. The creators of the named trace configurations to be queried.
tags	Optional list of strings. The user tags of the named trace configurations to be queried.
names	Optional list of strings. The names of the named trace configurations to be queried.
as_trace_configuration_class	Optional boolean. If True the list for “traceCongifurations” in return will be a list of TraceConfiguration class instances. If False, the list will be a list of dictionaries of trace configuration instances. The default is False.

Returns

A dictionary with two keys: {“traceConfigurations”: list, “success”: bool}

The Trace Network Service exposes analytic capabilities (tracing) as well as validation of network topology.

property properties

returns the properties for the service

query_network_moments(moments_to_return=['all'], moment=None)

The query_network_moments operation returns the moments related to the network topology and operations against the topology. This includes when the topology was initially enabled, when it was last validated, when the topology was last disabled (and later enabled), and when the definition of the trace network was last modified.

Parameter	Description
moments_to_return	Optional List of Strings. Represents the collection of validate moments to return. Default is all. `Values: [“initialEnableTopology” | “fullValidateTopology” | “partialValidateTopology” | “enableTopology” | “disableTopology” | “definitionModification” | “indexUpdate” | “all” ]`
moment	Optional Epoch in Time in Seconds. Example: moment=1603109606

trace(locations, trace_type, moment=None, configuration=None, result_types=None, run_async=False)

A trace refers to a preconfigured algorithm that systematically travels a network to return results. Multiple parameters and properties are provided with the trace operation that support various analytic workflows. All traces use the network topology to read cached information about network features. This can improve performance of complex traces on large networks. Trace results are not guaranteed to accurately represent a trace network when dirty areas are present. The network topology must be validated to ensure that it reflects the most recent edits or updates made to the network.

Note

The active portal account must be licensed with the ArcGIS Trace Network user type extention to use this operation.

Parameter	Description
locations	Required list of dictionaries. The locations for starting points and barriers. An empty array must be used when performing a subnetwork trace if a subnetworkName is provided as part of the configuration - for example, locations=[]. The location is ignored by the trace if the following required properties are not defined: * percentAlong : required for edge features and objects. [{ "traceLocationType" : "startingPoint" | "barrier", "globalId" : <guid>, “percentAlong” : <double>, // optional }]
trace_type	Required string. Specifies the core algorithm that will be executed to analyze the network. Can be configured using the configuration parameter. Values: ‘connected’ | ‘subnetwork’ | ‘subnetworkController’ | ‘upstream’ | ‘downstream’ | ‘loops’ | ‘shortestPath’ | ‘isolation’
moment	Optional Integer. Specifies the session moment. This should only be specified if you do not want to use the current moment. Example: moment = <Epoch time in milliseconds>
configuration	Optional dictionary or instance of TraceConfiguration class. Specifies the collection of trace configuration properties. Depending on the trace_type, some properties are required. To see all configuration properties see: Trace Configuration Properties
result_types	Optional parameter specifying hte types of results to return. Note ArcGIS Enterprise 10.9.1 or later is required when using the connectivity type.

Returns

If asynchronous = True then the status URL is returned for the job. Otherwise,

a Dictionary of the Trace Results is returned.

trace_configurations()

The trace_configurations resource provides access to all trace configuration operations for a trace network. It is returned as an array of named trace configurations with the creator, name, and global ID for each.

validate_topology(envelope, return_edits=False)

Validating the network topology for a trace network maintains consistency between feature editing space and network topology space. Validating a network topology may include all or a subset of the dirty areas present in the network. Validation of network topology is supported synchronously and asynchronously.

Parameter	Description
envelope	Required Dictionary or Envelope. The envelope of the area to validate. { "xmin": <minimum x-coordinate>, "ymin": <minimum y-coordinate>, "xmax": <maximum x-coordinate>, "ymax": <maximum y-coordinate>, "spatialReference": { "wkid": <spatial reference well-known identifier>, "latestWkid": <the current wkid value associated with the wkid> } }
return_edits	Optional Boolean. Returned results are organized in a layer-by-layer fashion. If return_edits is set to True, each layer may have edited features returned in an editedFeatures object. The editedFeatures object returns full features including the original features prior to delete; the original and current features for updates; and the current rows for inserts, which may contain implicit changes (for example, as a result of a calculation rule). The response includes no editedFeatures and ‘exceededTransferLimit = true’ if the count of edited features to return is more than the maxRecordCount. If clients are using this parameter to maintain a cache, they should invalidate the cache when exceededTransferLimit = true is returned. If the server encounters an error when generating the list of edits is the response, exceededTransferLimit = true is also returned. Edited features are returned in the spatial reference of the feature service as defined by the service’s spatialReferenceobject or by the spatialReference of the layer’s extent object.

Returns

Dictionary indicating ‘success’ or ‘error’

The Utility Network Service exposes analytic capabilities (tracing) as well as validation of network topology and management of subnetworks (managing sources, updating subnetworks, exporting subnetworks, and so on). The Utility Network Service is conceptually similar to the Network Analysis Service for transportation networks.

apply_overrides(adds=None, deletes=None)

Deprecated since version 2.1.0.

Network attributes support the ability to have their values overridden without having to edit features and validate the network topology (build the index). The utility network also supports the ability to place ephemeral connectivity (for example, jumpers in an electrical network) between two devices or junctions without having to edit features or connectivity associations and validate the network topology (build the index). When specified by the client, a trace operation may optionally incorporate the network attribute and connectivity override values when the trace is run on.

associations()

The associations resource provides access to operations that allow you to query and extract useful information from the associations table of a utility network.

Note

Available starting at Enterprise 10.9.1

Returns

A dictionary with two keys

{"associations":list, "success": bool}

disable_subnetwork_controller(network_source_id, global_id, terminal_id, out_sr=None)

A subnetwork controller (or simply, a source or a sink) is the origin (or destination) of resource flow for a subset (or subnetwork) of the network. Examples of subnetwork controllers are circuit breakers in electric networks, town border stations in gas networks, and pump stations in water networks. Subnetwork controllers correspond to devices that have the Subnetwork Controller network category set. A source is removed with this method.

Parameter	Description
network_source_id	Required String. The network source ID that the subnetwork controller participates in.
global_id	Required String. The global ID of the device being disabled as a network controller.
terminal_id	Required String. The terminal ID of the device being disabled as a network controller.
out_sr	Required int. The output spatial reference as a wkid.

disable_topology()

Disables the network topology for a utility network. When the topology is disabled, feature and association edits do not generate dirty areas. Analytics and diagram generation can’t be performed when the topology is not present.

When the network topology is disabled, the following happens:

• All current rows in the topology tables are deleted.

• No dirty areas are generated from edits.

• Existing errors remain and can be addressed prior to enabling the network topology, without the overhead of dirty areas.

To perform certain network configuration tasks, the network topology must be disabled.

• Operation must be executed by the portal utility network owner.

• The topology can be disabled in the default version or in a named version. If the toplogy is disabled in a named version, the reconcile process can be used to inherit the state from the default branch version.

Returns

Dictionary indicating ‘success’ or ‘error’

enable_subnetwork_controller(network_source_id, global_id, terminal_id, subnetwork_controller_name, tier_name, subnetwork_name=None, description=None, notes=None, out_sr=None)

A subnetwork controller is the origin (or destination) of resource flow for a subset (or subnetwork) of the network (e.g., a circuit breaker in electric networks, a town border station in gas networks, or pump stations in water networks). Controllers correspond to Devices that have the Subnetwork Controller network category set.

Parameter	Description
network_source_id	Required String. The network source ID that the subnetwork controller participates in.
global_id	Required String. The global ID of the device being enabled as a network controller.
terminal_id	Required String. The terminal ID for the terminal on the device being enabled as a network controller.
subnetwork_controller_name	Required String. The name of the subnetwork controller.
tier_name	Required String. The name of the tier.
subnetwork_name	Optional String. Specifies the name of the subnetwork.
description	Optional String. Represents the description of the subnetwork controller.
notes	Optional String. The notes associated with the subnetwork controller.
out_sr	Optional Integer. The output spatial reference as a wkid (integer).

enable_topology(error_count=10000)

Enabling the network topology for a utility network is done on the DEFAULT version. Enabling is not supported in named versions. When the network topology is enabled, all feature and association edits generate dirty areas, which are then cleaned when the network topology is validated.

When the network topology is enabled, the following happens: - Existing errors are deleted. - The topology is built for the full extent of the network. - Error dirty areas are created for any newly discovered errors. - The network topology is marked as enabled.

Note

The active portal account must be licensed with the Advanced Editing user type extension to use this operation.

Parameter	Description
error_count	Optional Integer. Sets the threshold when the enable_topology will stop if the maximum number of errors is met. The default value is 10,000.

Returns

Dictionary indicating ‘success’ or ‘error’