Entities located in space with a set of properties can be represented as features.

# Obtain a feature from a feature layer:# Query a Feature Layer to get a Feature Set>>>feature_set=feature_layer.query(where="OBJECTID=1")# Assign a variable to the list of features in the Feature Set>>>feature_list=feature_set.features# Get an individual feature>>>feature=feature_list[0]# Verify the object type>>>type(feature)arcgis.features.feature.Feature# Print the string representation of the feature>>>feature{"geometry":{"x":-8238318.738276444,"y":4970309.724235498,"spatialReference":{"wkid":102100,"latestWkid":3857}},"attributes":{"Incident_Type":"Structural-Sidewalk Collapse","Location":"927 Broadway","Borough":"Manhattan","Creation_Date":1477743211000,"Closed_Date":null,"Latitude":40.7144215406227,"Longitude":-74.0060763804198,"ObjectId":1}}

propertyas_dict

Retrieves the feature layer as a dictionary.

Returns:

The feature as a dictionary

propertyas_row

Retrieves the feature as a tuple containing two lists:

List of:	Description
row values	the specific attribute values and geometry for this feature
field names	the name for each attribute field

Returns:

A tuple of two lists: row values and field names

propertyattributes

Get/Set the attribute values for a feature

Parameter	Description
value	Required dict.

Returns:

A dictionary of feature attribute values with field names as the key

#Example to set attribute values>>>feat_set=feature_layer.query(where="1=1")>>>feat_list=feat_set.features>>>feat=feat_list[0]>>>feat.attributes={"field1 : "value", field2 : "value"}

propertyfields

Retrieves the attribute field names for the feature as a list of strings

Returns:

A list of strings

classmethodfrom_dict(feature:str,sr:dict[str,str]|None=None)

Creates a Feature object from a dictionary.

Returns:

AFeature

classmethodfrom_json(json_str:str)

Creates a Feature object from a JSON string.

Returns:

AFeature

propertygeometry

Get/Set the geometry of the feature, if any.

Parameter	Description
value	Required string.Values: ‘Polyline’ | ‘Polygon’ | ‘Point’ Note Setting this value will override the current geometry dictionaryif already present.

Returns:

The feature’s geometry as a dictionary.

# Get the current geometry>>>feat_set=feature_layer.query(where="1=1")>>>feat_list=feat_set.features>>>feat=feat_list[0]>>>feat.geometry{'x':-8238318.738276444,'y':4970309.724235498,'spatialReference':{'wkid':102100,'latestWkid':3857}}

propertygeometry_type

Retrieves the geometry type of the Feature as a string.

Returns:

The geometry type of theFeature as a string

get_value(field_name:str)

Retrieves the value for a specified field name.

Parameter	Description
field_name	Required String. The name for each attribute field. Note feature.fields will return a list of all field names.

Returns:

The value for the specified attribute field of theFeature

set_value(field_name:str,value:dict|BaseGeometry|Point|MultiPoint|Polyline|Polygon)

Sets an attribute value for a given field name.

Parameter	Description
field_name	Required String. The name of the field to update.
value	Required. Value to update the field with.

Returns:

A boolean indicating whetherfield_name value was updated (True), or not updated (False).

# Usage Example>>>feat_set=feature_layer.query(where="OBJECTID=1")>>>feat=feat_set.features[0]>>>feat.fields['OBJECTID','FID_Commun','AREA','PERIMETER','NAME','COUNTY','CONAME']>>>feat.get_value("NAME")'Original Name'>>>feat.set_value(field_name="NAME",value="New Name")True

Note

To save edits from the above snippet, useedit_features()withfeat_set in a list as theupdates argument.

TheFeatureLayer class is the primary concept for working withFeature objectsin aGIS.

User objects create, import, export, analyze, edit, and visualize features,i.e. entities in space as feature layers.

Featurelayers can be added to and visualized using maps. They act as inputs to and outputs from featureanalysis tools.

Feature layers are created by publishing feature data to a GIS, and are exposed as a broader resource(Item) in theGIS. Feature layer objects can be obtained through the layers attribute on feature layer Items in the GIS.

append(item_id:str|None=None,upload_format:str='featureCollection',source_table_name:str|None=None,field_mappings:list[dict[str,str]]|None=None,edits:dict|None=None,source_info:dict|None=None,upsert:bool=False,skip_updates:bool=False,use_globalids:bool=False,update_geometry:bool=True,append_fields:list[str]|None=None,rollback:bool=False,skip_inserts:bool|None=None,upsert_matching_field:str|None=None,upload_id:str|None=None,layer_mappings:list[dict[str,int]]|None=None,*,return_messages:bool|None=None,future:bool=False)

Theappend method is used to update an existing hostedFeatureLayer object.See theAppend (Feature Service/Layer)page in the ArcGIS REST API documentation for more information.

Note

Theappend method is only available in ArcGIS Online and ArcGIS Enterprise 10.8.1+

Note

Please reference specific deployment documentation for important information on criteria thatmust be met before appending data will work:

• ArcGIS Online

• ArcGIS Enterprise

Parameter	Description
item_id	Optional string. The ID for the Portal item that contains the sourcefile.Used in conjunction with editsUploadFormat.
upload_format	Required string. The source append data format. Supported formatsvary by deployment and layer. See documentation for details: ArcGIS Enterprise append ArcGIS Online append Note You can find whether append is supported on a Feature Layer,and the specific formats the layer supports by checking theproperties: >>>featurelayer.properties.supportsAppendTrue>>>featureLayer.properties.supportedAppendFormats'sqlite,geoPackage,shapefile,filegdb,featureCollection''geojson,csv,excel,jsonl,featureService,pbf'
source_table_name	Required string. Required even when the source data contains onlyone table, e.g., for file geodatabase. # Example usage:source_table_name="Building"
field_mappings	Optional list. Used to map source data to a destination layer.Syntax: field_mappings=[{“name” : <”targetName”>, “sourceName” : < “sourceName”>}, …] # Example usage:field_mappings=[{"name":"CountyID","sourceName":"GEOID10"}]
edits	Optional dictionary. Only feature collection json is supported. Appendsupports all format through the upload_id or item_id.
source_info	Optional dictionary. This is only needed when appending data fromexcel or csv. The appendSourceInfo can be the publishing parameterreturned from analyze the csv or excel file.
upsert	Optional boolean. Optional parameter specifying whether the editsneeds to be applied as updates if the feature already exists.Default is false.
skip_updates	Optional boolean. Parameter is used only when upsert is true.
use_globalids	Optional boolean. Specifying whether upsert needs to use GlobalIdwhen matching features.
update_geometry	Optional boolean. The parameter is used only when upsert is true.Skip updating the geometry and update only the attributes forexisting features if they match source features by objectId orglobalId.(as specified by useGlobalIds parameter).
append_fields	Optional list. The list of destination fields to append to. This issupported when upsert=true or false. #Values:["fieldName1","fieldName2",....]
rollback	Optional boolean. Optional parameter specifying whether the upsertedits needs to be rolled back in case of failure. Default is false.
skip_inserts	Used only when upsert is true. Used to skip inserts if the value istrue. The default value is false.
upsert_matching_field	Optional string. The layer field to be used when matching featureswith upsert. ObjectId, GlobalId, and any other field that has aunique index can be used with upsert.This parameter overrides use_globalids; e.g., specifyingupsert_matching_field will be used even if you specifyuse_globalids = True.Example: upsert_matching_field=”MyfieldWithUniqueIndex”
upload_id	Optional string. The itemID field from anupload() response, corresponding withtheappendUploadId REST API argument. This argument should not beused along side theitem_id argument.
layer_mappings	Optional list of dictionaries. This is needed if the source is afeature service. It is used to map a source layer to a destinationlayer. Only one source can be mapped to a layer. Syntax: layerMappings=[{“id”: <layerID>, “sourceId”: <layer id>}]
return_messages	Optional Boolean. When set toTrue, the messages returned fromthe append will be returned. IfFalse, the response messages willnot be returned. This alters the output to be a tuple consisting ofa (Boolean, Dictionary).
future	Optional boolean. IfTrue, method runs asynchronously and a future object will bereturned. The process will return control to the user. IfFalse, method runs synchronously and process waits until theoperation completes before returning control back to user. This isthe default value.

Returns:

• Iffuture=False, A boolean indicating success (True), or failure (False). Whenreturn_messages isTrue, the response will return a tuple with a boolean indicatingsuccess or failure, and dictionary with the return messages.

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

# Usage Example>>>feature_layer.append(source_table_name="Building",field_mappings=[{"name":"CountyID","sourceName":"GEOID10"}],upsert=True,append_fields=["fieldName1","fieldName2",....,fieldname22],return_messages=False)<True>

calculate(where:str,calc_expression:list[dict[str,Any]],sql_format:str='standard',version:str|None=None,sessionid:str|None=None,return_edit_moment:bool|None=None,future:bool=False)

Thecalculate operation is performed on aFeatureLayerresource.calculate updates the values of one or more fields in anexisting feature service layer based on SQL expressions or scalarvalues. Thecalculate operation can only be used if thesupportsCalculate property of the layer isTrue.Neither the Shape field nor system fields can be updated usingcalculate. System fields includeObjectId andGlobalId.

Inputs	Description
where	Required String. A where clause can be used to limitthe updated records. Any legal SQL where clauseoperating on the fields in the layer is allowed.
calc_expression	Required List. The array of field/value info objectsthat contain the field or fields to update and theirscalar values or SQL expression. Allowed types aredictionary and list. List must be a list ofdictionary objects. Calculation Format is as follows: {“field” : “<field name>”, “value” : “<value>”}
sql_format	Optional String. The SQL format for thecalc_expression. It can be either standard SQL92(standard) or native SQL (native). The default isstandard. Values:standard,native
version	Optional String. The geodatabase version to applythe edits.
sessionid	Optional String. A parameter which is set by aclient during long transaction editing on a branchversion. The sessionid is a GUID value that clientsestablish at the beginning and use throughout theedit session.The sessionid ensures isolation during the editsession. This parameter applies only if theisDataBranchVersioned property of the layer istrue.
return_edit_moment	Optional Boolean. This parameter specifies whetherthe response will report the time edits wereapplied. If true, the server will return the timeedits were applied in the response’s edit momentkey. This parameter applies only if theisDataBranchVersioned property of the layer istrue.
future	Optional boolean. If True, a future object will bereturned and the processwill not wait for the task to complete. The default isFalse, which means wait for results. This applies to 10.8+ only

Returns:

A dictionary with the following format:

{‘updatedFeatureCount’: 1,‘success’: True}

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

# Usage Example 1:print(fl.calculate(where="OBJECTID < 2",calc_expression={"field":"ZONE","value":"R1"}))

# Usage Example 2:print(fl.calculate(where="OBJECTID < 2001",calc_expression={"field":"A","sqlExpression":"B*3"}))

propertycontainer

Get/Set theFeatureLayerCollection to which thislayer belongs.

Parameter	Description
value	RequiredFeatureLayerCollection.

Returns:

The Feature Layer Collection where the layer is stored

propertycontingent_values:dict[str,Any]

Returns the define contingent values for the given layer.:returns: Dict[str,Any]

delete_features(deletes:str|None=None,where:str|None=None,geometry_filter:GeometryFilter|None=None,gdb_version:str|None=None,rollback_on_failure:bool=True,return_delete_results:bool=True,future:bool=False)

Deletes features in aFeatureLayer orTable

Parameter	Description
deletes	Optional string. A comma separated string of OIDs to remove from theservice.
where	Optional string. A where clause for the query filter. Any legal SQLwhere clause operating on the fields in the layer is allowed.Features conforming to the specified where clause will be deleted.
geometry_filter	OptionalSpatialFilter. A spatial filter fromarcgis.geometry.filters module to filter results by a spatialrelationship with another geometry.
gdb_version	Optional string. The geodatabase version. This parameter applies onlyif theisDataVersioned property of the layer is true.
rollback_on_failure	Optional boolean. Optional parameter to specify if the edits shouldbe applied only if all submitted edits succeed. If false, the serverwill apply the edits that succeed even if some of the submittededits fail. If true, the server will apply the edits only if alledits succeed. The default value is true.
return_delete_results	Optional Boolean. Optional parameter that indicates whether a resultis returned per deleted row when the deleteFeatures operation is run.The default is true.
future	Optional boolean. If True, a future object will be returned and the processwill not wait for the task to complete. The default is False, which means wait for results.

Returns:

A dictionary if future=False (default), else Iffuture=True,then the result is aFuture object. Callresult() to get the response.

# Usage Example with only a "where" sql statement>>>fromarcgis.featuresimportFeatureLayer>>>gis=GIS("pro")>>>buck=gis.content.search("owner:"+gis.users.me.username)>>>buck_1=buck[1]>>>lay=buck_1.layers[0]>>>la_df=lay.delete_features(where="OBJECTID > 15")>>>la_df{'deleteResults':[{'objectId':1,'uniqueId':5,'globalId':None,'success':True},{'objectId':2,'uniqueId':5,'globalId':None,'success':True},{'objectId':3,'uniqueId':5,'globalId':None,'success':True},{'objectId':4,'uniqueId':5,'globalId':None,'success':True},{'objectId':5,'uniqueId':5,'globalId':None,'success':True},{'objectId':6,'uniqueId':6,'globalId':None,'success':True},{'objectId':7,'uniqueId':7,'globalId':None,'success':True},{'objectId':8,'uniqueId':8,'globalId':None,'success':True},{'objectId':9,'uniqueId':9,'globalId':None,'success':True},{'objectId':10,'uniqueId':10,'globalId':None,'success':True},{'objectId':11,'uniqueId':11,'globalId':None,'success':True},{'objectId':12,'uniqueId':12,'globalId':None,'success':True},{'objectId':13,'uniqueId':13,'globalId':None,'success':True},{'objectId':14,'uniqueId':14,'globalId':None,'success':True},{'objectId':15,'uniqueId':15,'globalId':None,'success':True}]}

edit_features(adds:FeatureSet|list[dict]|None=None,updates:FeatureSet|list[dict]|None=None,deletes:FeatureSet|list[dict]|None=None,gdb_version:str|None=None,use_global_ids:bool=False,rollback_on_failure:bool=True,return_edit_moment:bool=False,attachments:dict[str,list[Any]]|None=None,true_curve_client:bool=False,session_id:str|None=None,use_previous_moment:bool=False,datum_transformation:int|dict[str,Any]|None=None,future:bool=False)

Adds, updates, and deletes features to theassociatedFeatureLayer orTable in a single call.

Note

When making large number (250+ records at once) of edits,append should be used overedit_features to improveperformance and ensure service stability.

Inputs	Description
adds	OptionalFeatureSet/List. The array of features to be added.
updates	OptionalFeatureSet/List. The array of features to be updated.
deletes	OptionalFeatureSet/List. string of OIDs to remove from service
use_global_ids	Optional boolean. Instead of referencing the default Object ID field, the servicewill look at a GUID field to track changes. This means the GUIDs will be passedinstead of OIDs for delete, update or add features.
gdb_version	Optional string. The geodatabase version to apply edits. This parameterapplies only if theisDataVersioned property of the layer is true.
rollback_on_failure	Optional boolean. Optional parameter to specify if the edits should be applied onlyif all submitted edits succeed. If false, the server will apply the edits that succeedeven if some of the submitted edits fail. If true, the server will apply the editsonly if all edits succeed. The default value is true.
return_edit_moment	Optional boolean. Introduced at 10.5, only applicable with ArcGIS Server servicesonly. Specifies whether the response will report the time edits were applied. If setto true, the server will return the time in the response’s editMoment key. The defaultvalue is false.
attachments	Optional Dict. This parameter adds, updates, or deletes attachments. It applies onlywhen theuse_global_ids parameter is set to true. For adds, the globalIds of theattachments provided by the client are preserved. When useGlobalIds is true, updatesand deletes are identified by each feature or attachment globalId, rather than theirobjectId or attachmentId. This parameter requires the layer’ssupportsApplyEditsWithGlobalIds property to be true. Attachments to be added or updated can use either pre-uploaded data or base 64encoded data. Inputs Inputs Description adds List of attachments to add. updates List of attachments to update deletes List of attachments to delete See theApply Edits to a Feature Service layerin the ArcGIS REST API for more information.
true_curve_client	Optional boolean. Introduced at 10.5. Indicates to the server whether the client istrue curve capable. When set to true, this indicates to the server that true curvegeometries should be downloaded and that geometries containing true curves should beconsumed by the map service without densifying it. When set to false, this indicatesto the server that the client is not true curves capable. The default value is false.
session_id	Optional String. Introduced at 10.6. Thesession_id is a GUID value that clientsestablish at the beginning and use throughout the edit session. The sessionID ensuresisolation during the edit session. Thesession_id parameter is set by a clientduring long transaction editing on a branch version.
use_previous_moment	Optional Boolean. Introduced at 10.6. Theuse_previous_moment parameter is used toapply the edits with the same edit moment as the previous set of edits. This allows aneditor to apply single block of edits partially, complete another task and thencomplete the block of edits. This parameter is set by a client during long transactionediting on a branch version. When set to true, the edits are applied with the same edit moment as the previous setof edits. When set to false or not set (default) the edits are applied with a newedit moment.
datum_transformation	Optional Integer/Dictionary. This parameter applies a datum transformation whileprojecting geometries in the results when out_sr is different than the layer’s spatialreference. When specifying transformations, you need to think about which datumtransformation best projects the layer (not the feature service) to theoutSR andsourceSpatialReference property in the layer properties. For a list of valid datumtransformation ID values ad well-known text strings, seeUsing spatial references.For more information on datum transformations please see the transformationparameter in theProject operation documentation. Examples Inputs Description WKID Integer. Ex: datum_transformation=4326 WKT Dict. Ex: datum_transformation={“wkt”: “<WKT>”} Composite Dict. Ex: datum_transformation=```{‘geoTransforms’:[{‘wkid’:<id>,’forward’:<true|false>},{‘wkt’:’<WKT>’,’forward’:<True|False>}]}```
future	Optional Boolean. If theFeatureLayer hassupportsAsyncApplyEdits settoTrue, then edits can be applied asynchronously. If True, a future object will be returned and the processwill not wait for the task to complete. The default is False, which means wait for results.

Returns:

A dictionary by default, or Iffuture=True, then the result is aFuture object. Callresult() to get the response.The dictionary will contain keys “addResults”, “updateResults”, “deleteResults”, and “attachments” with the results of the operation.

# Usage Example 1:feature=[{'attributes':{'ObjectId':1,'UpdateDate':datetime.datetime.now(),}}]lyr.edit_features(updates=feature)>>>{'addResults':[],'updateResults':[{'objectId':1,'success':True}]},'deleteResults':[],}

# Usage Example 2:adds={"geometry":{"x":500,"y":500,"spatialReference":{"wkid":102100,"latestWkid":3857}},"attributes":{"ADMIN_NAME":"Fake Location"}}lyr.edit_features(adds=[adds])>>>{'addResults':[{'objectId':2542,'success':True}],'updateResults':[],'deleteResults':[],}

# Usage Example 3:lyr.edit_features(deletes=[2542])>>>{'addResults':[],'updateResults':[],'deleteResults':[{'objectId':2542,'success':True}],}

propertyestimates:dict[str,Any]

Returns up-to-date approximations of layer information, such as row countand extent. Layers that support this property will includeinfoInEstimates information in the layer’sproperties.

Currently available with ArcGIS Online and Enterprise 10.9.1+

Returns:

Dict[str, Any]

export_attachments(output_folder:str,label_field:str|None=None)

Exports attachments from theFeatureLayer in Imagenetformat using theoutput_label_field.

Parameter	Description
output_folder	Required string. Output folder where the attachments will be stored.If None, a default folder is created
label_field	Optional string. Field which contains the label/category of each feature.

Returns:

Nothing is returned from this method

propertyfield_groups:dict[str,Any]

Returns the defined list of field groups for a given layer.

Returns:

dict[str,Any]

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

Thefromitem method creates aFeatureLayer from anItemobject.

Parameter	Description
item	RequiredItem object. The type of item should be aFeatureService that represents aFeatureLayerCollection
layer_id	Required Integer. the id of the layer in feature layer collection (feature service).The default forlayer_id is 0.

Returns:

AFeatureSet object

# Usage Example>>>fromarcgis.featuresimportFeatureLayer>>>gis=GIS("pro")>>>buck=gis.content.search("owner:"+gis.users.me.username)>>>buck_1=buck[1]>>>buck_1.type'Feature Service'>>>new_layer=FeatureLayer.fromitem(item=buck_1)>>>type(new_layer)<class'arcgis.features.layer.FeatureLayer'>

generate_renderer(definition:dict,where:str|None=None)

Groups data using the supplied definition (classification definition) and an optional where clause. Theresult is a renderer object.

Note

Use baseSymbol and colorRamp to definethe symbols assigned to each class. If the operation is performedon a table, the result is a renderer object containing the dataclasses and no symbols.

Parameter	Description
definition	Required dict. The definition using the renderer that is generated.Use either class breaks or unique value classification definitions.SeeClassification Objects for additional details.
where	Optional string. A where clause for which the data needs to beclassified. Any legal SQL where clause operating on the fields inthe dynamic layer/table is allowed.

Returns:

A JSON Dictionary

# Example UsageFeatureLayer.generate_renderer(definition={"type":"uniqueValueDef","uniqueValueFields":["Has_Pool"],"fieldDelimiter":",","baseSymbol":{"type":"esriSFS","style":"esriSLSSolid","width":2},"colorRamp":{"type":"algorithmic","fromColor":[115,76,0,255],"toColor":[255,25,86,255],"algorithm":"esriHSVAlgorithm"}},where="POP2000 > 350000")

get_html_popup(oid:str|None)

Theget_html_popup method provides details about the HTML pop-upauthored by theUser using ArcGIS Pro or ArcGIS Desktop.

Parameter	Description
oid	Optional string. Object id of the feature to get the HTML popup.

Returns:

A string

get_unique_values(attribute:str,query_string:str='1=1')

Retrieves a list of unique values for a given attribute in theFeatureLayer.

Parameter	Description
attribute	Required string. The feature layer attribute to query.
query_string	Optional string. SQL Query that will be used to filter attributesbefore unique values are returned.ex. “name_2 like ‘%K%’”

Returns:

A list of unique values

# Usage Example with only a "where" sql statement>>>fromarcgis.featuresimportFeatureLayer>>>gis=GIS("pro")>>>buck=gis.content.search("owner:"+gis.users.me.username)>>>buck_1=buck[1]>>>lay=buck_1.layers[0]>>>layer=lay.get_unique_values(attribute="COUNTY")>>>layer['PITKIN','PLATTE','TWIN FALLS']

propertymanager

Themanager property is a helper object to manage theFeatureLayer, such asupdating its definition.

Returns:

AFeatureLayerManager

# Usage Example>>>manager=FeatureLayer.manager

propertymetadata

Get the Feature Layer’s metadata.

Note

If metadata is disabled on the GIS or thelayer does not support metadata,None will be returned.

Returns:

String of the metadata, if any

propertyproperties

Theproperties property retrieves and set properties of this object.

query(where:str='1=1',out_fields:str|list[str]='*',time_filter:list[datetime]|None=None,geometry_filter:GeometryFilter|None=None,return_geometry:bool=True,return_count_only:bool=False,return_ids_only:bool=False,return_distinct_values:bool=False,return_extent_only:bool=False,group_by_fields_for_statistics:str|None=None,statistic_filter:StatisticFilter|None=None,result_offset:int|None=None,result_record_count:int|None=None,object_ids:list[str]|None=None,distance:int|None=None,units:str|None=None,max_allowable_offset:int|None=None,out_sr:dict[str,int]|str|None=None,geometry_precision:int|None=None,gdb_version:str|None=None,order_by_fields:str|None=None,out_statistics:list[dict[str,Any]]|None=None,return_z:bool=False,return_m:bool=False,multipatch_option:tuple=None,quantization_parameters:dict[str,Any]|None=None,return_centroid:bool=False,return_all_records:bool=True,result_type:str|None=None,historic_moment:int|datetime|None=None,sql_format:str|None=None,return_true_curves:bool=False,return_exceeded_limit_features:bool|None=None,as_df:bool=False,datum_transformation:int|dict[str,Any]|None=None,time_reference_unknown_client:bool|None=None,**kwargs)

Thequery method queries aFeatureLayer based on asql statement.

Parameter	Description
where	Optional string. SQL-92 WHERE clause syntax on the fields in the layeris supported for most data sources. Some data sources have restrictionson what is supported. Hosted feature services in ArcGIS Enterprise runningon a spatiotemporal data source only support a subset of SQL-92.Below is a list of supported SQL-92 with spatiotemporal-based feature services: ( ‘<=’ | ‘>=’ | ‘<’ | ‘>’ | ‘=’ | ‘!=’ | ‘<>’ | LIKE )(AND | OR)(IS | IS_NOT)(IN | NOT_IN) ( ‘(’ ( expr ( ‘,’ expr )* )? ‘)’ )COLUMN_NAME BETWEEN LITERAL_VALUE AND LITERAL_VALUE
out_fields	Optional list of fields to be included in the returned result set.This list is a comma-delimited list of field names. You can also specifythe wildcard “*” as the value of this parameter. In this case, the queryresults include all the field values. Note If specifyingreturn_count_only,return_id_only, orreturn_extent_onlyas True, do not specify this parameter in order to avoid errors.
object_ids	Optional string. The object IDs of this layer or table to be queried.The object ID values should be a comma-separated string. Note There might be a drop in performance if the layer/table datasource resides in an enterprise geodatabase and more than1,000 object_ids are specified.
distance	Optional integer. The buffer distance for the input geometries.The distance unit is specified by units. For example, if thedistance is 100, the query geometry is a point, units is set tometers, and all points within 100 meters of the point are returned.
units	Optional string. The unit for calculating the buffer distance. Ifunit is not specified, the unit is derived from the geometry spatialreference. If the geometry spatial reference is not specified, theunit is derived from the feature service data spatial reference.This parameter only applies ifsupportsQueryWithDistance is true. Values:`esriSRUnit_Meter | esriSRUnit_StatuteMile | esriSRUnit_Foot | esriSRUnit_Kilometer |esriSRUnit_NauticalMile | esriSRUnit_USNauticalMile`
time_filter	Optional list. The format is of [<startTime>, <endTime>] usingdatetime.date, datetime.datetime or timestamp in milliseconds.Syntax: time_filter=[<startTime>, <endTime>] ; specified as datetime.date, datetime.datetime or timestamp inmilliseconds
geometry_filter	Optional fromfilters. Allows for the information tobe filtered on spatial relationship with another geometry.
max_allowable_offset	Optional float. This option can be used to specify themax_allowable_offset to be used for generalizing geometries returnedby the query operation.The max_allowable_offset is in the units of out_sr. If out_sr is notspecified, max_allowable_offset is assumed to be in the unit of thespatial reference of the layer.
out_sr	Optional Integer. The WKID for the spatial reference of the returnedgeometry.
geometry_precision	Optional Integer. This option can be used to specify the number ofdecimal places in the response geometries returned by the queryoperation.This applies to X and Y values only (not m or z-values).
gdb_version	Optional string. The geodatabase version to query. This parameterapplies only if the isDataVersioned property of the layer is true.If this is not specified, the query will apply to the publishedmap’s version.
return_geometry	Optional boolean. If true, geometry is returned with the query.Default is true.
return_distinct_values	Optional boolean. If true, it returns distinct values based on thefields specified in out_fields. This parameter applies only if thesupportsAdvancedQueries property of the layer is true. This parametercan be used with return_count_only to return the count of distinctvalues of subfields. Note Make sure to set return_geometry to False if this is set to True.Otherwise, reliable results will not be returned.
return_ids_only	Optional boolean. Default is False. If true, the response onlyincludes an array of object IDs. Otherwise, the response is afeature set. When object_ids are specified, setting this parameter totrue is invalid.
return_count_only	Optional boolean. If true, the response only includes the count(number of features/records) that would be returned by a query.Otherwise, the response is a feature set. The default is false. Thisoption supersedes the returnIdsOnly parameter. IfreturnCountOnly = true, the response will return both the count andthe extent.
return_extent_only	Optional boolean. If true, the response only includes the extent ofthe features that would be returned by the query. IfreturnCountOnly=true, the response will return both the count andthe extent.The default is false. This parameter applies only if thesupportsReturningQueryExtent property of the layer is true.
order_by_fields	Optional string. One or more field names on which thefeatures/records need to be ordered. Use ASC or DESC for ascendingor descending, respectively, following every field to control theordering.example: STATE_NAME ASC, RACE DESC, GENDER Note If specifyingreturn_count_only,return_id_only, orreturn_extent_onlyas True, do not specify this parameter in order to avoid errors.
group_by_fields_for_statistics	Optional string. One or more field names on which the values need tobe grouped for calculating the statistics.example: STATE_NAME, GENDER
out_statistics	Optional list of dictionaries. The definitions for one or more field-basedstatistics to be calculated. Syntax: [ { “statisticType”: “<count | sum | min | max | avg | stddev | var>”,“onStatisticField”: “Field1”,“outStatisticFieldName”: “Out_Field_Name1” },{ “statisticType”: “<count | sum | min | max | avg | stddev | var>”,“onStatisticField”: “Field2”,“outStatisticFieldName”: “Out_Field_Name2” } ]
statistic_filter	OptionalStatisticFilter instance. The definitions for one or more field-basedstatistics can be added, e.g. statisticType, onStatisticField, oroutStatisticFieldName. Syntax: sf = StatisticFilter()sf.add(statisticType=”count”, onStatisticField=”1”, outStatisticFieldName=”total”)sf.filter
return_z	Optional boolean. If true, Z values are included in the results ifthe features have Z values. Otherwise, Z values are not returned.The default is False.
return_m	Optional boolean. If true, M values are included in the results ifthe features have M values. Otherwise, M values are not returned.The default is false.
multipatch_option	Optional x/y footprint. This option dictates how the geometry ofa multipatch feature will be returned.
result_offset	Optional integer. This option can be used for fetching query resultsby skipping the specified number of records and starting from thenext record (that is, resultOffset + 1th). This option is ignoredif return_all_records is True (i.e. by default).This parameter cannot be specified if the service does not support pagination.
result_record_count	Optional integer. This option can be used for fetching query resultsup to the result_record_count specified. When result_offset isspecified but this parameter is not, the map service defaults it tomax_record_count. The maximum value for this parameter is the valueof the layer’s max_record_count property. This option is ignored ifreturn_all_records is True (i.e. by default).
quantization_parameters	Optional dict. Used to project the geometry onto a virtual grid,likely representing pixels on the screen.
return_centroid	Optional boolean. Used to return the geometry centroid associatedwith each feature returned. If true, the result includes the geometrycentroid. The default is false. Only supported on layer withpolygon geometry type.
return_all_records	Optional boolean. When True, the query operation will call theservice until all records that satisfy the where_clause arereturned. Note: result_offset and result_record_count will beignored if return_all_records is True. Also, if return_count_only,return_ids_only, or return_extent_only are True, this parameterwill be ignored. If this parameter is set to False but no other limit isspecified, the default is True.
result_type	Optional string. The result_type parameter can be used to controlthe number of features returned by the query operation.Values: None | standard | tile
historic_moment	Optional integer. The historic moment to query. This parameterapplies only if the layer is archiving enabled and thesupportsQueryWithHistoricMoment property is set to true. Thisproperty is provided in the layer resource. If historic_moment is not specified, the query will apply to thecurrent features.
sql_format	Optional string. The sql_format parameter can be either standardSQL92 standard or it can use the native SQL of the underlyingdatastore native. The default is none which means the sql_formatdepends on useStandardizedQuery parameter.Values: none | standard | native
return_true_curves	Optional boolean. When set to true, returns true curves in outputgeometries. When set to false, curves are converted to densifiedpolylines or polygons.
return_exceeded_limit_features	Optional boolean. Optional parameter which is true by default. Whenset to true, features are returned even when the results include‘exceededTransferLimit’: True. When set to false and querying with resultType = tile features arenot returned when the results include ‘exceededTransferLimit’: True.This allows a client to find the resolution in which the transferlimit is no longer exceeded without making multiple calls.
as_df	Optional boolean. If True, the results are returned as a DataFrameinstead of a FeatureSet.
datum_transformation	Optional Integer/Dictionary. This parameter applies a datum transformation whileprojecting geometries in the results when out_sr is different than the layer’s spatialreference. When specifying transformations, you need to think about which datumtransformation best projects the layer (not the feature service) to theoutSR andsourceSpatialReference property in the layer properties. For a list of valid datumtransformation ID values ad well-known text strings, seeCoordinate systems andtransformations.For more information on datum transformations, please see the transformationparameter in theProject operation. Examples Inputs Description WKID Integer. Ex: datum_transformation=4326 WKT Dict. Ex: datum_transformation={“wkt”: “<WKT>”} Composite Dict. Ex: datum_transformation=```{‘geoTransforms’:[{‘wkid’:<id>,’forward’:<true|false>},{‘wkt’:’<WKT>’,’forward’:<True|False>}]}```
kwargs	Optional dict. Optional parameters that can be passed to the Queryfunction. This will allow users to pass additional parameters notexplicitly implemented on the function. A complete list of functionsavailable is documented on the Query REST API.

Returns:

AFeatureSet containing the features matching the query unless another return typeis specified, such asreturn_count_only,return_extent_only, orreturn_ids_only.

# Usage Example with only a "where" sql statement>>>feat_set=feature_layer.query(where="OBJECTID= 1")>>>type(feat_set)<arcgis.Features.FeatureSet>>>>feat_set[0]<Feature1>

# Usage Example of an advanced query returning the object IDs instead of Features>>>id_set=feature_layer.query(where="OBJECTID1",out_fields=["FieldName1, FieldName2"],distance=100,units='esriSRUnit_Meter',return_ids_only=True)>>>type(id_set)<Array>>>>id_set[0]<"Item_id1">

# Usage Example of an advanced query returning the number of features in the query>>>search_count=feature_layer.query(where="OBJECTID1",out_fields=["FieldName1, FieldName2"],distance=100,units='esriSRUnit_Meter',return_count_only=True)>>>type(search_count)<Integer>>>>search_count<149>

# Usage Example with "out_statistics" parameter>>>stats=[{'onStatisticField':"1",'outStatisticFieldName':"total",'statisticType':"count"}]>>>feature_layer.query(out_statistics=stats,as_df=True)# returns a DataFrame containing total count

# Usage Example with "StatisticFilter" parameter>>>fromarcgis._impl.common._filtersimportStatisticFilter>>>sf1=StatisticFilter()>>>sf1.add(statisticType="count",onStatisticField="1",outStatisticFieldName="total")>>>sf1.filter# This is to print the filter content>>>feature_layer.query(statistic_filter=sf1,as_df=True)# returns a DataFrame containing total count

query_3d(where:str|None=None,out_fields:str|None=None,object_ids:str|None=None,distance:int|None=None,units:str|None=None,time_filter:str|int|None=None,geometry_filter:Geometry|dict|None=None,gdb_version:str|None=None,return_distinct_values:bool|None=None,order_by_fields:str|None=None,group_by_fields_for_statistics:str|None=None,out_statistics:list[dict]|None=None,result_offset:int|None=None,result_record_count:int|None=None,historic_moment:int|None=None,sql_format:str|None=None,format_3d_objects:str|None=None,time_reference_unknown_client:bool|None=None)

The query3D operation allows clients to query 3D object features and isbased on the feature service layer query operation. The 3D object featurelayer still supports layer and service level feature service query operations.

Parameter	Description
where	Optional string. SQL-92 WHERE clause syntax on the fields in the layeris supported for most data sources. Some data sources have restrictionson what is supported. Hosted feature services in ArcGIS Enterprise runningon a spatiotemporal data source only support a subset of SQL-92.Below is a list of supported SQL-92 with spatiotemporal-based feature services: ( ‘<=’ | ‘>=’ | ‘<’ | ‘>’ | ‘=’ | ‘!=’ | ‘<>’ | LIKE )(AND | OR)(IS | IS_NOT)(IN | NOT_IN) ( ‘(’ ( expr ( ‘,’ expr )* )? ‘)’ )COLUMN_NAME BETWEEN LITERAL_VALUE AND LITERAL_VALUE
out_fields	Optional list of fields to be included in the returned result set.This list is a comma-delimited list of field names. You can also specifythe wildcard “*” as the value of this parameter to return allfields in the result.
object_ids	Optional string. The object IDs of this layer or table to be queried.The object ID values should be a comma-separated string. Note There might be a drop in performance if the layer/table datasource resides in an enterprise geodatabase and more than1,000 object_ids are specified.
distance	Optional integer. The buffer distance for the input geometries.The distance unit is specified by units. For example, if thedistance is 100, the query geometry is a point, units is set tometers, and all points within 100 meters of the point are returned.
units	Optional string. The unit for calculating the buffer distance. Ifunit is not specified, the unit is derived from the geometry spatialreference. If the geometry spatial reference is not specified, theunit is derived from the feature service data spatial reference.This parameter only applies ifsupportsQueryWithDistance is true. Values:`esriSRUnit_Meter | esriSRUnit_StatuteMile | esriSRUnit_Foot | esriSRUnit_Kilometer |esriSRUnit_NauticalMile | esriSRUnit_USNauticalMile`
time_filter	Optional list. The format is of [<startTime>, <endTime>] usingdatetime.date, datetime.datetime or timestamp in milliseconds.Syntax: time_filter=[<startTime>, <endTime>] ; specified as datetime.date, datetime.datetime or timestamp inmilliseconds
geometry_filter	Optional fromfilters. Allows for the information tobe filtered on spatial relationship with another geometry.
gdb_version	Optional string. The geodatabase version to query. This parameterapplies only if the isDataVersioned property of the layer is true.If this is not specified, the query will apply to the publishedmap’s version.
return_distinct_values	Optional boolean. If true, it returns distinct values based on thefields specified in out_fields. This parameter applies only if thesupportsAdvancedQueries property of the layer is true. This parametercan be used with return_count_only to return the count of distinctvalues of subfields. Note Make sure to set return_geometry to False if this is set to True.Otherwise, reliable results will not be returned.
order_by_fields	Optional string. One or more field names on which thefeatures/records need to be ordered. Use ASC or DESC for ascendingor descending, respectively, following every field to control theordering.example: STATE_NAME ASC, RACE DESC, GENDER Note If specifyingreturn_count_only,return_id_only, orreturn_extent_onlyas True, do not specify this parameter in order to avoid errors.
group_by_fields_for_statistics	Optional string. One or more field names on which the values need tobe grouped for calculating the statistics.example: STATE_NAME, GENDER
out_statistics	Optional list of dictionaries. The definitions for one or more field-basedstatistics to be calculated. Syntax: [ { “statisticType”: “<count | sum | min | max | avg | stddev | var>”,“onStatisticField”: “Field1”,“outStatisticFieldName”: “Out_Field_Name1” },{ “statisticType”: “<count | sum | min | max | avg | stddev | var>”,“onStatisticField”: “Field2”,“outStatisticFieldName”: “Out_Field_Name2” } ]
result_offset	Optional integer. This option can be used for fetching query resultsby skipping the specified number of records and starting from thenext record (that is, resultOffset + 1th). This option is ignoredif return_all_records is True (i.e. by default).
result_record_count	Optional integer. This option can be used for fetching query resultsup to the result_record_count specified. When result_offset isspecified but this parameter is not, the map service defaults it tomax_record_count. The maximum value for this parameter is the valueof the layer’s max_record_count property. This option is ignored ifreturn_all_records is True (i.e. by default).
historic_moment	Optional integer. The historic moment to query. This parameterapplies only if the layer is archiving enabled and thesupportsQueryWithHistoricMoment property is set to true. Thisproperty is provided in the layer resource. If historic_moment is not specified, the query will apply to thecurrent features.
sql_format	Optional string. The sql_format parameter can be either standardSQL92 standard or it can use the native SQL of the underlyingdatastore native. The default is none which means the sql_formatdepends on useStandardizedQuery parameter.Values: none | standard | native
format_3d_objects	Optional string. Specifies the 3D format that will be used to requesta feature. If set to a valid format ID (see layer resource), the geometryof the feature response will be a 3D envelope of the 3D object and willinclude asset maps for the 3D object. Since formats are created asynchronously,review the flags field in the asset map to determine if the format is available(conversionStatus is COMPLETED). If conversionStatus is INPROGRESS, the formatis not ready. Request the feature again later. If a feature does not have the specified format, the feature will still be returnedaccording to the query parameters (such as the where clause), but theasset mapping will be missing. Values: “3D_dae” | “3D_dwg” | “3D_fbx” | “3D_glb” | “3D_gltf” | “3D_ifc”| “3D_obj” | “3D_shapebuffer” | “3D_shapebufferg” | “3D_usdc” | “3D_usdz”
time_reference_unknown_client	Optional boolean. Settingtime_reference_unknown_client as Trueindicates that the client is capable of working with data values thatare not in UTC. If its not set to true, and the service layer’sdatesInUnknownTimeZone property is true, then an error is returned.The default is False Its possible to define a service’s time zone of date fields as unknown.Setting the time zone as unknown means that date values will be returnedas-is from the database, rather than as date values in UTC. Non-hostedfeature services can be set to use an unknown time zone usingArcGIS Server Manager. Setting the time zones to unknown alsosets the datesInUnknownTimeZone layer property as true. Currently,hosted feature services do not support this setting. This setting doesnot apply to editor tracking date fields which are stored and returnedin UTC even when the time zone is set to unknown. Most clients released prior to ArcGIS Enterprise 10.9 will not be ableto work with feature services that have an unknown time setting.

Returns:

A dictionary containing the feature, asset map, and asset information for the layer.

USAGEEXAMPLE:Query3Dobjects# Import the required modulesfromarcgis.gisimportGISfromarcgis.featuresimportFeatureLayer# Connect to your GISgis=GIS(profile="your_enterprise_profile")# Search for the feature layersearch_result=gis.content.search("3D Object Feature Layer","Feature Layer")feature_layer=search_result[0]# Create a FeatureLayer objectlayer=FeatureLayer(feature_layer.url,gis)# Query the 3D objectsresult=layer.query_3d(where="OBJECTID < 10",out_fields="*",format_3d_objects="3D_dae")print(result)

query_analytics(out_analytics:list[dict],where:str='1=1',out_fields:str|list[str]='*',analytic_where:str|None=None,geometry_filter:GeometryFilter|None=None,out_sr:dict[str,int]|str|None=None,return_geometry:bool=True,order_by:str|None=None,result_type:str|None=None,cache_hint:str|None=None,result_offset:int|None=None,result_record_count:int|None=None,quantization_param:dict[str,Any]|None=None,sql_format:str|None=None,future:bool=True,**kwargs)

Thequery_analytics exposes the standardSQL windows functions that computeaggregate and ranking values based on a group of rows called windowpartition. The window function is applied to the rows after thepartitioning and ordering of the rows.query_analytics defines awindow or user-specified set of rows within a query result set.query_analytics can be used to compute aggregated values such as movingaverages, cumulative aggregates, or running totals.

Note

See thequery method for a similar function.

SQL Windows Function

A window function performs a calculation across a set of rows (SQL partitionor window) that are related to the current row. Unlike regular aggregatefunctions, use of a window function does not return single output row. Therows retain their separate identities with each calculation appended to therows as a new field value. The window function can access more than justthe current row of the query result.

query_analytics currently supports the following windows functions:

• Aggregate functions

• Analytic functions

• Ranking functions

Aggregate Functions

Aggregate functions are deterministic function that perform a calculation ona set of values and return a single value. They are used in the select listwith optional HAVING clause. GROUP BY clause can also be used to calculatethe aggregation on categories of rows.query_analytics can be used tocalculate the aggregation on a specific range of value. Supported aggregatefunctions are:

• Min

• Max

• Sum

• Count

• AVG

• STDDEV

• VAR

Analytic Functions

Several analytic functions available now in all SQL vendors to compute anaggregate value based on a group of rows or windows partition. Unlikeaggregation functions, analytic functions can return single or multiple rowsfor each group.

• CUM_DIST

• FIRST_VALUE

• LAST_VALUE

• LEAD

• LAG

• PERCENTILE_DISC

• PERCENTILE_CONT

• PERCENT_RANK

Ranking Functions

Ranking functions return a ranking value for each row in a partition. Dependingon the function that is used, some rows might receive the same value as other rows.

• RANK

• NTILE

• DENSE_RANK

• ROW_NUMBER

Partitioning

Partitions are extremely useful when you need to calculate the same metric overdifferent group of rows. It is very powerful and has many potential usages. Forexample, you can add partition by to your window specification to look atdifferent groups of rows individually.

partitionBy clause divides the query result set into partitions and the sqlwindow function is applied to each partition.The ‘partitionBy’ clause normally refers to the column by which the result ispartitioned. ‘partitionBy’ can also be a value expression (column expression orfunction) that references any of the selected columns (not aliases).

Parameter	Description
out_analytics	Required List. A set of analytics to calculate on the Feature Layer. The definitions for one or more field-based or expression analyticsto be computed. This parameter is supported only on layers/tables thatreturntrue forsupportsAnalytics property. Note IfoutAnalyticFieldName is empty or missing, the server assignsa field name to the returned analytic field. The argument should be a list of dictionaries that define analystics.An analytic definition specifies: the type of analytic - key:analyticType the field or expression on which it is to be computed - key:onAnalyticField the resulting output field name -key:outAnalyticFieldName the analytic specifications -analysticParameters SeeOverviewfor details. # Dictionary structure and options for this parameter[{"analyticType":"<COUNT | SUM | MIN | MAX | AVG | STDDEV | VAR | FIRST_VALUE, LAST_VALUE, LAG, LEAD, PERCENTILE_CONT, PERCENTILE_DISC, PERCENT_RANK, RANK, NTILE, DENSE_RANK, EXPRESSION>","onAnalyticField":"Field1","outAnalyticFieldName":"Out_Field_Name1","analyticParameters":{"orderBy":"<orderBy expression","value":<doublevalue>,//percentilevalue"partitionBy":"<field name or expression>","offset":<integer>,//usedbyLAG/LEAD"windowFrame":{"type":"ROWS"|"RANGE","extent":{"extentType":"PRECEDING"|"BOUNDARY","PRECEDING":{"type":<"UNBOUNDED"|"NUMERIC_CONSTANT"|"CURRENT_ROW">"value":<numericconstantvalue>}"BOUNDARY":{"start":"UNBOUNDED_PRECEDING","NUMERIC_PRECEDING","CURRENT_ROW","startValue":<numericconstantvalue>,"end":<"UNBOUNDED_FOLLOWING"|"NUMERIC_FOLLOWING"|"CURRENT_ROW","endValue":<numericconstantvalue>}}}}}}] # Usage Example:>>>out_analytics=[{"analyticType":"FIRST_VALUE","onAnalyticField":"POP1990","analyticParameters":{"orderBy":"POP1990","partitionBy":"state_name"},"outAnalyticFieldName":"FirstValue"}]
where	Optional string. The default is 1=1. The selection sql statement.
out_fields	Optional List of field names to return. Field names can be specifiedeither as a List of field names or as a comma separated string.The default is “*”, which returns all the fields.
analytic_where	Optional String. A where clause for the query filter that applies tothe result set of applying the source where clause and all other params.
geometry_filter	Optional from arcgis.geometry.filter. Allows for the information tobe filtered on spatial relationship with another geometry.
out_sr	Optional Integer. The WKID for the spatial reference of the returnedgeometry.
return_geometry	Optional boolean. If true, geometry is returned with the query.Default is true.
order_by	Optional string. One or more field names on which thefeatures/records need to be ordered. Use ASC or DESC for ascendingor descending, respectively, following every field to control theordering.example: STATE_NAME ASC, RACE DESC, GENDER
result_type	Optional string. The result_type parameter can be used to controlthe number of features returned by the query operation.Values: None | standard | tile
cache_hint	Optional Boolean. If you are performing the same query multiple times,a user can ask the server to cache the call to obtain the resultsquicker. The default isFalse.
result_offset	Optional integer. This option can be used for fetching query resultsby skipping the specified number of records and starting from thenext record (that is, resultOffset + 1th).
result_record_count	Optional integer. This option can be used for fetching query resultsup to the result_record_count specified. When result_offset isspecified but this parameter is not, the map service defaults it tomax_record_count. The maximum value for this parameter is the valueof the layer’s max_record_count property.
quantization_parameters	Optional dict. Used to project the geometry onto a virtual grid,likely representing pixels on the screen.
sql_format	Optional string. The sql_format parameter can be either standardSQL92 standard or it can use the native SQL of the underlyingdatastore native. The default is none which means the sql_formatdepends on useStandardizedQuery parameter.Values:none | standard | native
future	Optional Boolean. This determines if aFuture object is returned(True) the method returns the results directly (False).

Returns:

A Pandas DataFrame (pd.DataFrame)

query_date_bins(bin_field:str|datetime,bin_specs:dict,out_statistics:list[dict[str,Any]],time_filter:TimeFilter|None=None,geometry_filter:GeometryFilter|dict|None=None,bin_order:str|None=None,where:str|None=None,return_centroid:bool|None=False,in_sr:int|dict[str,Any]|None=None,out_sr:int|dict[str,Any]|None=None,spatial_rel:str|None=None,quantization_params:dict[str,Any]|None=None,result_offset:int|None=None,result_record_count:int|None=None,return_exceeded_limit_features:bool|None=False)

Thequery_date_bins operation is performed on aFeatureLayer.This operation returns a histogram of features divided into bins based on a date field.The response can include statistical aggregations for each bin, such as a count orsum, and may also include the aggregate geometries (in other words, centroid) forpoint layers.

The parameters define the bins, the aggregate information returned, and the includedfeatures. Bins are defined using the bin parameter. Theout_statistics andreturn_centroid parameters define the information each bin will provide. Includedfeatures can be specified by providing atime extent,where condition, and aspatial filter, similar to a query operation.

The contents of thebin_specs parameter provide flexibility for defining binboundaries. Thebin_specs parameter’sunit property defines the time width of eachbin, such as one year, quarter, month, day, or hour. Fixed bins can use multiple units forthese time widths. Theresult_offset property defines an offset within that time unit.For example, if your bin unit isday, and you want bin boundaries to go from noon tonoon on the next day, the offset would be 12 hours.

Features can be manipulated with thetime_filter,where, andgeometry_filterparameters. By default, the result will expand to fit the feature’s earliest and latestpoint of time. Thetime_filter parameter defines a fixed starting point and endingpoint of the features based on the field used in binField. Thewhere andgeometry_filter parameters allow additional filters to be put on the data.

This operation is only supported on feature services using a spatiotemporal datastore. As well, the service propertysupportsQueryDateBins must be set to true.

To use pagination with aggregated queries on hosted feature services in ArcGISEnterprise, thesupportsPaginationOnAggregatedQueries property must betrue onthe layer. Hosted feature services using a spatiotemporal data store do not currentlysupport pagination on aggregated queries.

Parameter	Description
bin_field	Required String. The date field used to determine which bin eachfeature falls into.
bin_specs	Required Dict. A dictionary that describes the characteristics ofbins, such as the size of the bin and its starting position. Thesize of each bin is determined by the number of time units denotedby thenumber andunit properties. The starting position of the bin is the earliest moment in thespecified unit. For example, each year begins at midnight of January1. An offset inside the bin parameter can provide an offset to thestarting position of the bin. This can contain a positive ornegative integer value. A bin can take two forms: either a calendar bin or a fixed bin. Acalendar bin is aware of calendar-specific adjustments, such asdaylight saving time and leap seconds. Fixed bins are, by contrast,always a specific unit of measurement (for example, 60 seconds in aminute, 24 hours in a day) regardless of where the date and time ofthe bin starts. For this reason, some calendar-specific units areonly supported as calendar bins. # Calendar bin>>>bin_specs={"calendarBin":{"unit":"year","timezone":"US/Arizona","offset":{"number":5,"unit":"hour"}}}# Fixed bin>>>bin_specs={"fixedBin":{"number":12,"unit":"hour","offset":{"number":5,"unit":"hour"}}}
out_statistics	Required List of Dicts. The definitions for one or more field-basedstatistics to be calculated: {"statisticType":"<count | sum | min | max | avg | stddev | var>","onStatisticField":"Field1","outStatisticFieldName":"Out_Field_Name1"}
time_filter	Optional list. The format is of [<startTime>, <endTime>] usingdatetime.date, datetime.datetime or timestamp in milliseconds.
geometry_filter	Optional fromfilters. Allows for theinformation to be filtered on spatial relationship with anothergeometry.
bin_order	Optional String. Either “ASC” or “DESC”. Determines whether resultsare returned in ascending or descending order. Default is ascending.
where	Optional String. A WHERE clause for the query filter. SQL ‘92 WHEREclause syntax on the fields in the layer is supported for most datasources.
return_centroid	Optional Boolean. Returns the geometry centroid associated with allthe features in the bin. If true, the result includes the geometrycentroid. The default is false. This parameter is only supported onpoint data.
in_sr	Optional Integer. The WKID for the spatial reference of the inputgeometry.
out_sr	Optional Integer. The WKID for the spatial reference of the returnedgeometry.
spatial_rel	Optional String. The spatial relationship to be applied to the inputgeometry while performing the query. The supported spatialrelationships include intersects, contains, envelop intersects,within, and so on. The default spatial relationship is intersects(esriSpatialRelIntersects). Other options areesriSpatialRelContains,esriSpatialRelCrosses,esriSpatialRelEnvelopeIntersects,esriSpatialRelIndexIntersects,esriSpatialRelOverlaps,esriSpatialRelTouches, andesriSpatialRelWithin.
quantization_params	Optional Dict. Used to project the geometry onto a virtual grid,likely representing pixels on the screen. # upperLeft origin position{"mode":"view","originPosition":"upperLeft","tolerance":1.0583354500042335,"extent":{"type":"extent","xmin":-18341377.47954369,"ymin":2979920.6113554947,"xmax":-7546517.393554582,"ymax":11203512.89298139,"spatialReference":{"wkid":102100,"latestWkid":3857}}}# lowerLeft origin position{"mode":"view","originPosition":"lowerLeft","tolerance":1.0583354500042335,"extent":{"type":"extent","xmin":-18341377.47954369,"ymin":2979920.6113554947,"xmax":-7546517.393554582,"ymax":11203512.89298139,"spatialReference":{"wkid":102100,"latestWkid":3857}}} SeeQuantization parameters JSON propertiesfor details on format of this parameter. Note This parameter only applies if the layer’ssupportsCoordinateQuantization property istrue.
result_offset	Optional Int. This parameter fetches query results by skipping thespecified number of records and starting from the next record. Thedefault is 0. Note: This parameter only applies if the layer’ssupportsPagination property istrue.
result_record_count	Optional Int. This parameter fetches query results up to the valuespecified. Whenresult_offset is specified, but this parameteris not, the map service defaults to the layer’smaxRecordCountproperty. The maximum value for this parameter is the value of themaxRecordCount property. The minimum value entered for thisparameter cannot be below 1. Note: This parameter only applies if the layer’ssupportsPagination property istrue.
return_exceeded_limit_features	Optional Boolean. When set toTrue, features are returned evenwhen the results include"exceededTransferLimit":true. Thisallows a client to find the resolution in which the transfer limitis no longer exceeded without making multiple calls. The defaultvalue isFalse.

Returns:

A Dict containing the resulting features and fields.

# Usage Example>>>flyr_item=gis.content.search("*","Feature Layer")[0]>>>flyr=flyr_item.layers[0]>>>qy_result=flyr.query_date_bins(bin_field="boundary",bin_specs={"calendarBin":{"unit":"day","timezone":"America/Los_Angeles","offset":{"number":8,"unit":"hour"}}},out_statistics=[{"statisticType":"count","onStatisticField":"objectid","outStatisticFieldName":"item_sold_count"},{"statisticType":"avg","onStatisticField":"price","outStatisticFieldName":"avg_daily_revenue "}],time=[1609516800000,1612195199999])>>>qy_result{"features":[{"attributes":{"boundary":1609516800000,"avg_daily_revenue":300.40,"item_sold_count":79}},{"attributes":{"boundary":1612108800000,"avg_daily_revenue":null,"item_sold_count":0}}],"fields":[{"name":"boundary","type":"esriFieldTypeDate"},{"name":"item_sold_count","alias":"item_sold_count","type":"esriFieldTypeInteger"},{"name":"avg_daily_revenue","alias":"avg_daily_revenue","type":"esriFieldTypeDouble"}],"exceededTransferLimit":false}

query_related_records(object_ids:str,relationship_id:str,out_fields:str='*',definition_expression:str|None=None,return_geometry:bool=True,max_allowable_offset:float|None=None,geometry_precision:int|None=None,out_wkid:int|None=None,gdb_version:str|None=None,return_z:bool=False,return_m:bool=False,historic_moment:int|datetime|None=None,return_true_curve:bool=False)

Thequery_related_records operation is performed on aFeatureLayerresource. The result of this operation are feature sets groupedby source layer/table object IDs. Each feature set containsFeature objects including the values for the fields requested bythe user. For related layers, if you request geometryinformation, the geometry of each feature is also returned inthe feature set. For related tables, the feature set does notinclude geometries.

Note

See thequery method for a similar function.

Parameter	Description
object_ids	Required string. The object IDs of the table/layer to be queried
relationship_id	Required string. The ID of the relationship to be queried.
out_fields	Required string. the list of fields from the related table/layerto be included in the returned feature set. This list is a commadelimited list of field names. If you specify the shape field in thelist of return fields, it is ignored. To request geometry, setreturn_geometry to true. You can also specify the wildcard “*” asthe value of this parameter. In this case, the results will includeall the field values.
definition_expression	Optional string. The definition expression to be applied to therelated table/layer. From the list of objectIds, only those recordsthat conform to this expression are queried for related records.
return_geometry	Optional boolean. If true, the feature set includes the geometryassociated with each feature. The default is true.
max_allowable_offset	Optional float. This option can be used to specify themax_allowable_offset to be used for generalizing geometries returnedby the query operation. The max_allowable_offset is in the units ofthe outSR. If out_wkid is not specified, then max_allowable_offsetis assumed to be in the unit of the spatial reference of the map.
geometry_precision	Optional integer. This option can be used to specify the number ofdecimal places in the response geometries.
out_wkid	Optional Integer. The spatial reference of the returned geometry.
gdb_version	Optional string. The geodatabase version to query. This parameterapplies only if the isDataVersioned property of the layer queried istrue.
return_z	Optional boolean. If true, Z values are included in the results ifthe features have Z values. Otherwise, Z values are not returned.The default is false.
return_m	Optional boolean. If true, M values are included in the results ifthe features have M values. Otherwise, M values are not returned.The default is false.
historic_moment	Optional Integer/datetime. The historic moment to query. This parameterapplies only if the supportsQueryWithHistoricMoment property of thelayers being queried is set to true. This setting is provided in thelayer resource. If historic_moment is not specified, the query will apply to thecurrent features. Syntax: historic_moment=<Epoch time in milliseconds>
return_true_curves	Optional boolean. Optional parameter that is false by default. Whenset to true, returns true curves in output geometries; otherwise,curves are converted to densifiedPolyline orPolygon objects.

Returns:

Dictionary of the query results

# Usage Example:# Query returning the related records for a feature with objectid value of 2,# returning the values in the 6 attribute fields defined in the `field_string`# variable:>>>field_string="objectid,attribute,system_name,subsystem_name,class_name,water_regime_name">>>rel_records=feat_lyr.query_related_records(object_ids="2",relationship_id=0,out_fields=field_string,return_geometry=True)>>>list(rel_records.keys())['fields','relatedRecordGroups']>>>rel_records["relatedRecordGroups"][{'objectId':2,'relatedRecords':[{'attributes':{'objectid':686,'attribute':'L1UBHh','system_name':'Lacustrine','subsystem_name':'Limnetic','class_name':'Unconsolidated Bottom','water_regime_name':'Permanently Flooded'}}]}]

query_top_features(top_filter:dict[str,str]|None=None,where:str|None=None,objectids:list[str]|None=None,start_time:datetime|None=None,end_time:datetime|None=None,geometry_filter:GeometryFilter|None=None,out_fields:str='*',return_geometry:bool=True,return_centroid:bool=False,max_allowable_offset:float|None=None,out_sr:dict[str,int]|str|None=None,geometry_precision:int|None=None,return_ids_only:bool=False,return_extents_only:bool=False,order_by_field:str|None=None,return_z:bool=False,return_m:bool=False,result_type:str|None=None,as_df:bool=True)

Thequery_top_features is performed on aFeatureLayer. This operation returns afeature set or spatially enabled dataframe based on the top features by order within a group. For example, whenquerying counties in the United States, you want to return the top five counties by population ineach state. To do this, you can usequery_top_features to group by state name, order by desc onthe population and return the first five rows from each group (state).

Thetop_filter parameter is used to set the group by, order by, and count criteria used ingenerating the result. The operation also has many of the same parameters (for example, whereand geometry) as the layer query operation. However, unlike the layer query operation,query_top_features does not support parameters such as outStatistics and its related parametersor return distinct values. Consult theadvancedQueryCapabilities layer property for more details.

If the feature layer collection supports thequery_top_features operation, it will include“supportsTopFeaturesQuery”: True, in theadvancedQueryCapabilities layer property.

Note

See thequery method for a similar function.

Parameter	Description
top_filter	Required Dict. Thetop_filter define the aggregation of the data. groupByFields define the field or fields used to aggregate your data. topCount defines the number of features returned from the top features query and is a numeric value. orderByFields defines the order in which the top features will be returned. orderByFields can be specified ineither ascending (asc) or descending (desc)order, ascending being the default. Example: {“groupByFields”: “worker”, “topCount”: 1, “orderByFields”: “employeeNumber”}
where	Optional String. A WHERE clause for the query filter. SQL ‘92 WHEREclause syntax on the fields in the layer is supported for most datasources.
objectids	Optional List. The object IDs of the layer or table to be queried.
start_time	Optional Datetime. The starting time to query for.
end_time	Optional Datetime. The end date to query for.
geometry_filter	Optional from arcgis.geometry.filter. Allows for the information tobe filtered on spatial relationship with another geometry.
out_fields	Optional String. The list of fields to include in the return results.
return_geometry	Optional Boolean. If False, the query will not return geometries.The default is True.
return_centroid	Optional Boolean. If True, the centroid of the geometry will beadded to the output.
max_allowable_offset	Optional float. This option can be used to specify themax_allowable_offset to be used for generalizing geometries returnedby the query operation.The max_allowable_offset is in the units of out_sr. If out_sr is notspecified, max_allowable_offset is assumed to be in the unit of thespatial reference of the layer.
out_sr	Optional Integer. The WKID for the spatial reference of the returnedgeometry.
geometry_precision	Optional Integer. This option can be used to specify the number ofdecimal places in the response geometries returned by the queryoperation.This applies to X and Y values only (not m or z-values).
return_ids_only	Optional boolean. Default is False. If true, the response onlyincludes an array of object IDs. Otherwise, the response is afeature set.
return_extent_only	Optional boolean. If true, the response only includes the extent ofthe features that would be returned by the query. IfreturnCountOnly=true, the response will return both the count andthe extent.The default is false. This parameter applies only if thesupportsReturningQueryExtent property of the layer is true.
order_by_field	Optional Str. Optional string. One or more field names on which thefeatures/records need to be ordered. Use ASC or DESC for ascendingor descending, respectively, following every field to control theordering.example: STATE_NAME ASC, RACE DESC, GENDER
return_z	Optional boolean. If true, Z values are included in the results ifthe features have Z values. Otherwise, Z values are not returned.The default is False.
return_m	Optional boolean. If true, M values are included in the results ifthe features have M values. Otherwise, M values are not returned.The default is false.
result_type	Optional String. The result_type can be used to control the numberof features returned by the query operation.Values: none | standard | tile
as_df	Optional Boolean. If False, the result is returned as a FeatureSet.If True (default) the result is returned as a spatially enabled dataframe.

Returns:

Default is a pd.DataFrame, but when`as_df=False` returns aFeatureSet.If`return_count_only=True`, the return type is Integer.If`return_ids_only=True`, a list of value is returned.

propertyrenderer

Get/Set the Renderer of the Feature Layer.

Parameter	Description
value	Required dict.

Note

When set, this overrides the default symbology when displaying it on a webmap.

Returns:

`InsensitiveDict`: A case-insensitivedict like object used to update and alter JSONA varients of a case-less dictionary that allows for dot and bracket notation.

propertytime_filter

Thetime_filter method is used to set a time filter instead of querying time-enabled mapservice layers or time-enabled feature service layers, a time filtercan be specified. Time can be filtered as a single instant or byseparating the two ends of a time extent with a comma.

Note

Thetime_filter method is supported starting at Enterprise 10.7.1+.

Input	Description
value	Required Datetime/List Datetime. This is a singleor list of start/stop date.

Returns:

A string of datetime values as milliseconds from epoch

update_metadata(file_path:str)

Theupdate_metadata updates aFeatureLayer metadata from an xml file.

Parameter	Description
file_path	Required String. The path to the .xml file that contains the metadata.

Returns:

A boolean indicating success (True), or failure (False)

validate_sql(sql:str,sql_type:str='where')

Thevalidate_sql operation validates anSQL-92 expression or WHEREclause.Thevalidate_sql operation ensures that anSQL-92 expression, suchas one written by a user through a user interface, is correctbefore performing another operation that uses the expression.

Note

For example,validateSQL can be used to validate information that issubsequently passed in as part of the where parameter of the calculate operation.

validate_sql also prevents SQL injection. In addition, all tableand field names used in the SQL expression or WHERE clause arevalidated to ensure they are valid tables and fields.

Parameter	Description
sql	Required String. The SQL expression of WHERE clause to validate.Example: “Population > 300000”
sql_type	Optional String. Three SQL types are supported in validate_sql where(default) - Represents the custom WHERE clause the usercan compose when querying a layer or using calculate. expression - Represents an SQL-92 expression. Currently,expression is used as a default value expression when adding anew field or using the calculate API. statement - Represents the full SQL-92 statement that can bepassed directly to the database. No current ArcGIS REST APIresource or operation supports using the full SQL-92 SELECTstatement directly. It has been added to the validateSQL forcompleteness.Values:where | expression | statement

Returns:

A JSON Dictionary indicating ‘success’ or ‘error’