TheGIS class is representative of a single ArcGIS Online organization or an ArcGIS Enterprise deployment.TheGIS object provides helper objects to manage (search, create, retrieve) GIS resources such as content, users,and groups.

Additionally, theGIS object has properties to query its state, which is accessible using the properties attribute.

The constructor constructs aGIS object given a url and user credentials to ArcGIS Onlineor an ArcGIS Enterprise portal. User credentials can be passed in using username/passwordpair, or key_file/cert_file pair (in case of PKI). Supports built-in users, LDAP, PKI, Integrated Windows Authentication(using NTLM and Kerberos) and Anonymous access.

If no url is provided, ArcGIS Online is used. If username/passwordor key/cert files are not provided, the currently logged-in user’s credentials (IWA) or anonymous access is used.

Persisted profiles for the GIS can be created by giving the GIS authorization credentials andspecifying a profile name. The profile stores all of the authorization credentials (except the password) in theuser’s home directory in an unencrypted config file named .arcgisprofile. The profile securely stores the passwordin an O.S. specific password manager through thekeyring python module.

Once a profile has been saved, passing the profile parameter by itself uses the authorization credentials savedin the configuration file/password manager by that profile name. Multiple profiles can be created and used inparallel.

SeeWorking with different authentication schemesin the ArcGIS API for Python guide for examples.

# Retrieving a token from a GIS object>>>fromarcgis.gisimportGIS>>>gis=GIS(url="url to Web GIS",username="user_name",password="secure_password")>>>token=gis.session.auth.token>>>token'3BMHr9i ... RTxekAdWkSmF9cKQIkM7DLy.'

In addition to explicitly named parameters, the GIS object supports optional key wordarguments:

# Usage Example 1: Anonymous Login to ArcGIS Onlinegis=GIS()

# Usage Example 2: Built-in Login to ArcGIS Onlinegis=GIS(username="someuser",password="secret1234")

# Usage Example 3: Built-in Login to ArcGIS Enterprisegis=GIS(url="http://pythonplayground.esri.com/portal",username="user1",password="password1")

# Usage Example 4: Built-in Login to ArcGIS Enterprise, ignoring SSL errorsgis=GIS(url="http://pythonplayground.esri.com/portal",username="user1",password="password1",verify_cert=False)

# Usage Example 5: Anonymous ArcGIS Online Login with Proxygis=GIS(proxy={'http':'http://127.0.0.1:8888','https':'http://127.0.0.1:8887'})

# Usage Example 6: PKI Login to ArcGIS Enterprise, using PKCS12 user certificategis=GIS(url="https://pkienterprise.esri.com/portal",cert_file="C:\users\someuser\mycert.pfx",password="password1")

# Usage Example 7: Login with token (actual token abbreviated for this illustration)gis=GIS(token="3G_e-FSoJdwxBgSA0RiOZg7zJVVqlOG-ENw83UtoUzDdz4 ... _L2aQMrthrEq7vKYBn39HGSc.",referer="https://www.arcgis.com")

# Usage Example 8: Login with API Key (actual token abbreviated for this illustration)gis=GIS(api_key="APKSoJdwxBgSA0RiOZg7zJVVqlOG-ENw83UtoUzDdz4 ... _L2aQMrth39HGSc.",referer="https")

# Usage Example 9: Using a Proxyproxy={'http':'http://10.10.1.10:3128','https':'http://10.10.1.10:1080',}gis=GIS(proxy=proxy)

# Usage Example 10: Using a CA_BUNDLE specifying SSL certificatescerts=r"./CA_CERTS/cacert.pem"gis=GIS(profile="your_enterprise_admin_profile",ca_bundles=certs)

# Usage Example 11: Using a CA_BUNDLE specifying multiple SSL certificatescerts=[r"./CA_CERTS/cacert.pem",r"./CA_CERTS/cacert2.pem",...,r"./CA_CERTS/cacertN.pem"]gis=GIS(profile="your_enterprise_admin_profile",ca_bundles=certs)

propertyapi_keys

Theapi_keys property returns an instance ofAPIKeyManager object which allowsthe User to generate, manage and modify API Keys for controlled application access.

Note

The API Key manager is only available for ArcGIS Online

Returns:

AnAPIKeyManager object

propertycontent

Thecontent property is the resource manager for GIS content. SeeContentManager formore information.

propertydatastore

Thedatastore property returns the manager foruser-managed data storeitems.

Note

This is only available with ArcGIS Enterprise 10.7+.SeePortalDataStore formore information.

Returns:

APortalDataStore object

propertygroups

Thegroups property is resource manager for GIS groups. SeeGroupManager for moreinformation.

propertyhosting_servers:list

Returns the hosting servers for the GIS

Returns:

list

propertyhub

Thehub property is the resource manager for GIS hub. SeeHub for more information.

propertylanguages:list[dict[str,Any]]

Lists the available languages.

Returns:

List[Dict[str, Any]]

map(location:str|None=None,mode:str='2D')

Themap method creates a map widget centered at the declared location with the specifiedzoom level. If an address is provided, it is geocodedusing the GIS’s configured geocoders. Provided a match is found, the geographicextent of the matched address is used as the extent of the map.SeeMap for more information.

Note

The map widget is only supported within a Jupyter Notebook. IE11 is no longer supported.Please use the latest version of Google Chrome, Mozilla Firefox, Apple Safari, or Microsoft Edge.

Parameter	Description
location	Optional string. The address or lat-long tuple of where the map is to be centered.
mode	Optional string of either ‘2D’ or ‘3D’ to specify map mode. Defaults to ‘2D’.

Note

If the Jupyter Notebook server is running over http, you need toconfigure your ArcGIS Enterprise portal or ArcGIS Online organization to allow your host and port; or elseyou will run into CORS issues when displaying this map widget.

This can be accomplished by signing into your ArcGIS Enterprise portal or ArcGIS Online organization in abrowser, then navigating to:

Organization >Settings >Security >Allow origins >Add >http://localhost:8888(replace with the host/port you are running on)

# Usage Example>>>gis=GIS(url="http://pythonplayground.esri.com/portal",username="user1",password="password1")>>>gis.map("Durham,NC")

Returns:

Amap orscene.

propertynotebook_server:list['NotebookServer']|list['AGOLNotebookManager']

Thenotebook_server property provides access to theNotebookServer registeredwith the organization or enterprise.:return:List [NotebookServer]

propertyorg_settings

The portal settings resource is used to return a view of theportal’s configuration as seen by the current users, eitheranonymous or logged in. Information returned by this resourceincludes helper services, allowed redirect URIs, and the currentconfiguration for any access notices or information banners.

Parameter

Description

settings

Required Dict. A dictionary of the settings Fields Description anonymousAccessNotice Dict. A JSON object representing a notice that is shown to your organization’s anonymous users.Ex: {‘title’: ‘Anonymous Access Notice Title’, ‘text’: ‘Anonymous Access Notice Text’, ‘buttons’: ‘acceptAndDecline’, ‘enabled’: True} authenticatedAccessNotice Dict. A JSON object representing a notice that is shown to your organization’s authenticated users.Ex: {‘title’: ‘Authenticated Access Notice Title’, ‘text’: ‘Authenticated Access Notice Text’, ‘buttons’: ‘okOnly’, ‘enabled’: True} informationalBanner Dict. A JSON object representing the informational banner that is shown at the top of your organization’s page.Ex: {‘text’: ‘Header Text’, ‘bgColor’: ‘grey’, ‘fontColor’: ‘blue’, ‘enabled’: True} clearEmptyFields Bool. If True, any empty dictionary will be set to null.

Returns:

Dictionary indicating ‘success’ or ‘error’

propertypages

Thepages property is the resource manager for a Page of an Enterprise Site. Seepages for more information.

propertyproperties

properties manages the actual properties of the GIS object.

To see all the properties that can be found in the GIS object, refer to theportal properties documentation atPortal Properties.

Returns:

A dictionary-like object called a PropertyMap of the properties of the GIS object.

propertyregions:list[dict[str,Any]]

Lists the available regions.

Returns:

List[Dict[str, Any]]

propertyservers:dict

Returns the servers registered with ArcGIS Enterprise. For ArcGISOnline, the return value isNone.

Returns:

dict

propertysession:EsriSession

Provides the raw Esri Session object

Returns:

AnEsriSession object.

propertysites

Thesites property is the resource manager for Enterprise Sites. Seesites for more information.

propertysubscription_information:dict

Returns the ArcGIS Online Subscription Information for a Site.

Returns:

dictionary

propertysymbol_service:arcgis.layers.SymbolService|None

Symbol service is an ArcGIS Server utility service that provides accessto operations to build and generate images for Esri symbols to beconsumed by internal and external web applications.

Returns:

ASymbolService object or None

update_properties(properties_dict:dict[str,Any])

Theupdate_properties method updates the GIS’s properties from those inproperties_dict. This methodcan be useful for updating the utility services used by the GIS.

Parameter	Description
properties_dict	Required dictionary. A dictionary of just those properties andvalues that are to be updated.

Returns:

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

Note

For examples of the property names and key/values to use when updating utility services,refer to theCommon parameterspage in the ArcGIS REST API.

# Usage Example: Update the geocode servicegis=GIS(profile='xyz')upd={'geocodeService':[{"singleLineFieldName":"Single Line Input","name":"AtlantaLocator","url":"https://some.server.com/server/rest/services/GeoAnalytics/AtlantaLocator/GeocodeServer","itemId":"abc6e1fc691542938917893c8944606d","placeholder":"","placefinding":"true","batch":"true","zoomScale":10000}]}gis.update_properties(upd)

propertyurl

Theurl property is a read-only URL of your GIS connection.

propertyusers

Theusers property is the resource manager for GIS users. SeeUserManager for moreinformation.

propertyvelocity

The resource manager for ArcGIS Velocity. SeeVelocity:return:Velocity

propertyversion

Theversion property returns the GIS version number

Bases:dict

TheItem class represents an item in the GIS, where an item is simply considered a unit of content in the GIS.Each item has a unique identifier and a well-known URL that is independent of the user owning the item.For a comprehensive list of properties of an item please see the REST API documentationhere .Additionally, each item can have associated binary or textual data that’s available via the item data resource.For example, an item of typeMap Package returns the actual bits corresponding to themap package via the item data resource.

Items that have layers (eg FeatureLayerCollection items and ImageryLayer items) and tables havethe dynamiclayers andtables properties to get to the individual layers/tables in this item.

add_comment(comment:str)

Theadd_comment method adds a comment to an item.

Note

Theadd_comment method is only available only to authenticated users who have access to the item.

Parameter	Description
comment	Required string. Text to be added as a comment to a specific item.

Returns:

Comment ID if successful, None if failure occurs.

# Usage Example>>>item.add_comment("Detailed Comment on the Item")

add_relationship(rel_item:Item,rel_type:str)

Theadd_relationship method adds a relationship from the current item torel_item.

Note

Note: Relationships are not tied to an item. Instead, they are directional links from an origin itemto a destination item and have a type. The type of the relationship defines the valid origin and destinationitem types as well as some rules. SeeRelationship types in REST API help for more information.Users don’t have to own the items they relate unless so defined by the rules of the relationshiptype.

Users can only delete relationships they create.

Relationships are deleted automatically if one of the two items is deleted.

Parameter	Description
rel_item	Required Item object corresponding to the related item.
rel_type	Required string. The type of the related item; is one of[‘Map2Service’, ‘WMA2Code’, ‘Map2FeatureCollection’, ‘MobileApp2Code’,‘Service2Data’, ‘Service2Service’]. SeeRelationship Types in the REST API helpfor more information on this parameter.

Returns:

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

# Usage Example>>>item.add_relationship(reL_item=item2,rel_type='Map2FeatureCollection')<True>

propertyapp_info

Theapp_info property is a resource for accessing application information. If the parent item is registeredusing the register app operation,app_info returns information pertaining to the registered app.Every registered app gets an App ID and App Secret, which are titled client_id and client_secret, respectively,in the terminology of OAuth.

Returns:

ADictionary

propertyattachments_size:int|None

Theattachments_size property returns the total size of the attachments for the item.The item has to support this property.

Note

The size is returned in bytes. To get the size in megabytes, divide the size by 1024*1024.This is only supported for ArcGIS Online.

Returns:

The size in bytes.

propertycan_delete:bool

Checks if the Item can be removed from the system.

Returns:

bool

can_reassign(target_user:str|User)→tuple[bool,dict[str,Any]]

Checks if the Item can be reassigned to a new user. Users assignedthe defaultadministrator role, or a custom role withadministrative privileges, can perform this operation. The itemowner can also use this operation; if the item owner that performsthis operation is not a default administrator, or assigned a customrole with administrative privileges, they must have theportal:user:reassignItems privilege assigned to them to transfercontent to another user.

Parameter	Description
target_user	Required string orUser. The stringmust be ausername value. This will be the userreceiving the item.

Returns:

tuple[bool, dict[str,Any]]

propertycomments

Thecomments property gets a list of comments for a given item.

propertycontent_status

The content_status property states if an Item is authoritative or deprecated. Thisgivens owners and administrators of Item the ability to warn users that theyshould be either this information or not.

Parameter	Description
value	Optional string or None. Defines if an Item is deprecated orauthoritative.If a value of None is given, then the value will be reset. Allowed Values: authoritative org_authoritative public_authoritative deprecated Note SeeOrganization verificationfor requirements to usepublic_authoritative status.

#Usage Example: Setting status to org_authoritative:>>>gis=GIS(profile="your_organization_profile")>>>dep_item=gis.content.get("<item_id>")>>>dep_item.content_status="org_authoritative">>>print(dep_item.content_status)org_authoritative

copy(title:str|None=None,tags:list[str]|str|None=None,snippet:str|None=None,description:str|None=None,layers:list[int]|None=None)

Thecopy method allows for the creation of an item that is derived from the current Item.

For layers,copy will create a new item that uses the URL as a reference.For non-layer based items, these will be copied and the exact same data will beprovided.

If title, tags, snippet of description is not provided the values fromitem will be used.Thecopy method can be used in a variety of situations, such as:

1. Vector tile service sprite customization

2. Limiting feature service exposure

3. Sharing content by reference with groups

4. Creating backup items.

Parameter	Description
title	Optional string. The name of the new item.
tags	Optional list of string. Descriptive words that help in thesearching and locating of the published information.
snippet	Optional string. A brief summary of the information beingpublished.
description	Optional string. A long description of the Item beingpublished.
layers	Optional list of integers. If you have a layer with multipleand you only want specific layers, an index can be providedthose layers. If nothing is provided, all layers will bevisible.

Returns:

AnItem object

**UsageExample**>>>item.copy()<Itemtitle:"gisslideshow - Copy 94452b"type:MicrosoftPowerpointowner:geoguy>>>>item.copy(title="GIS_Tutorial")<Itemtitle:"GIS_Tutorial"type:MicrosoftPowerpointowner:geoguy>>>>item.copy()<Itemtitle:"NZTiles - Copy 021a06"type:VectorTileLayerowner:geoguy>

copy_feature_layer_collection(service_name:str,layers:list[int]|str|None=None,tables:list[int]|str|None=None,folder:str|None=None,description:str|None=None,snippet:str|None=None,owner:str|User|None=None)

Thecopy_feature_layer_collection method allows users to copy existing Feature Layer Collections and selectthe layers/tables that the user wants in the service. It is quite similar to thecopy method, but onlycopies the selected Feature Layer Collections.

Parameter	Description
service_name	Required string. It is the name of the service.
layers	Optional list/string. This is a either a list of integers or a commaseperated list of integers as a string. Each index value representsa layer in the feature layer collection.
tables	Optional list/string. This is a either a list of integers or a commaseperated list of integers as a string. Each index value representsa table in the feature layer collection.
folder	Optional string. This is the name of the folder to place in. Thedefault is None, which means the root folder.
description	Optional string. This is the Item description of the service.
snippet	Optional string. This is the Item’s snippet of the service. It isno longer than 250 characters.
owner	Optional string/User. The default is the current user, but if youwant the service to be owned by another user, pass in this value.

Returns:

If successful, returns anItem object. Otherwise, returns None on failure.

# Usage Example>>>item.copy_feature_layer_collection(service_name="service_name",layers="1,4,5,8")

copy_item(*,title:str|None=None,tags:list[str]|str|None=None,folder:str|None=None,include_resources:bool=False,include_private:bool=False)

Thecopy_item operation creates a newItem that is a copy of the originalItem on the server side. It isquite similar to thecopy method, but only creates a newItem.

Thecopy_item method is allowed for the following:

1. Original item being copied is owned by the user invoking the copy operation.

2. TheUser object is an administrator.

3. TheUser object has itemControl update capability.

Additionally, there are several caveats to thecopy_item method. First, the new item created by thecopy_item operation will have a system generated itemID. Additionally, hosted services are copied asreference only. Reserved keywords, ratings, views, comments and listing properties are reset for the new item.Sharing access of the original item is not preserved and sharing access of new item is set to private.Lastly, relationships and dependencies of the original item are not maintained in the new item.

Note

This method is only available on ArcGIS Online or ArcGIS Enterprise 10.9 or higher

Returns:

AnItem object

create_thumbnail(update:bool=True)

Thecreate_thumbnail method creates a Thumbnail for a feature service portal item using the service’ssymbology and the print service registered for the enterprise.

Parameter	Description
update	Optional boolean. When set to True, the item will be updated with thethumbnail generated in this call, else it will not update the item.The default is True.

Returns:

ADataFile object

create_tile_service(title:str,min_scale:float,max_scale:float,cache_info:dict[str,Any]|None=None,build_cache:bool=False)

Thecreate_tile_service method allows publishers and administrators to publish hosted featurelayers and hosted feature layer views as a tile service.

Parameter	Description
title	Required string. The name of the new service.
min_scale	Required float. The smallest scale at which to view data.
max_scale	Required float. The largest scale at which to view data.
cache_info	Optional dictionary. If not none, administrator provides thetile cache info for the service. The default is the ArcGIS Online scheme.
build_cache	Optional boolean. Default is False; if True, the cache will bebuilt at publishing time. This will increase the time it takesto publish the service.

Returns:

TheItem object if successfully added, None if unsuccessful.

# Usage Example>>>item.create_tile_service(title="SeasideHeightsNJTiles",min_scale=70000.0,max_scale=80000.0)

delete(force:bool=False,dry_run:bool=False,permanent:bool=False)

Thedelete method deletes the item. If the item is unable to be deleted , a RuntimeException is raised.To know if you can safely delete the item, use the optional parameter ‘dry_run’ in order to test the operationwithout actually deleting the item.

Parameter	Description
force	Optional boolean. Available in ArcGIS Enterprise 10.6.1 and higher.Force deletion is applicable only to items that were orphaned whena server federated to the ArcGIS Enterprise was removed accidentallybefore properly unfederating it. When called on other items, it hasno effect.
dry_run	Optional boolean. Available in ArcGIS Enterprise 10.6.1 and higher.IfTrue, checks if the item can be safely deleted and gives you backeither a dictionary with details. If dependent items are preventingdeletion, a list of such Item objects are provided.
permanent	Optional boolean. Available in ArcGIS Online, setting to True willpermanently delete the item rather than sending it to the recycle bin.

Returns:

A boolean indicating success (True), or failure (False). Whendry_run is used, a dictionary containingdetails of the item is returned.

USAGEEXAMPLE:Successfuldeletionofanitemitem1=gis.content.get('itemId12345')item1.delete()>>True

USAGEEXAMPLE:Faileddeletionofanitemitem1=gis.content.get('itemId12345')item1.delete()>>RuntimeError:Unabletodeleteitem.ThisserviceitemhasarelatedServiceitem>>(ErrorCode:400)

USAGEEXAMPLE:Dryruntocheckdeletionofanitemitem1=gis.content.get('itemId12345abcde')item1.delete(dry_run=True)>>{'can_delete':False,>>'details':{'code':400,>>'message':'Unable to delete item. This service item has a related Service item',>>'offending_items':[<Itemtitle:"Chicago_accidents_WFS"type:WFSowner:sharing1>]}}

Note

During thedry run, if you receive a list of offending items, attempt to delete them first before deletingthe current item. You can in turn calldry_run on those items to ensure they can be deleted safely.

delete_info(file:str)

This is available for all items and allows you to delete an individual file from an item’s esriinfo folder.

Parameter	Description
file	Required String. The file to be deleted.

delete_rating()

Thedelete_rating method removes the rating the calling user added for the specified item.

delete_relationship(rel_item:Item,rel_type:str)

Thedelete_relationship method deletes a relationship between this item and the rel_item.

Parameter	Description
rel_item	Required Item object corresponding to the related item.
rel_type	Required string. The type of the related item; is one of[‘Map2Service’, ‘WMA2Code’, ‘Map2FeatureCollection’, ‘MobileApp2Code’,‘Service2Data’, ‘Service2Service’]. SeeRelationship Types in the REST API helpfor more information on this parameter.

Returns:

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

# Usage Exampleitem.delete_relationship(item2,'Map2FeatureCollection')

delete_thumbnail()→bool

Deletes the item’s thumbnail

Returns:

bool

propertydependencies

Thedependencies property returns a class to manage an item’sdependencies.

Returns:

ItemDependency object.

dependent_to()

Thedependent_to method returns items, urls, etc that are dependent to this item.

Note

This method only available for items in an ArcGIS Enterprise organization.

dependent_upon()

Thedependent_upon method returns items, urls, etc that this item is dependent on.

Note

This method only available for items in an ArcGIS Enterprise organization.

download(save_path:str|None=None,file_name:str|None=None)

Thedownload method downloads the data to the specified folder or a temporary folder, if a folder is not provided.

Parameter	Description
save_path	Optional string. Folder location to download the file to.
file_name	Optional string. The name of the file.

Returns:

The download path if data was available, otherwise None.

# Usage Example>>>item.download("C:\ARCGIS\Projects","hurricane_data")

download_metadata(save_folder:str|None=None)

Thedownload_metadata method is similar to thedownload method but only downloads the item metadata forthe specified item id. Items with metadata have ‘Metadata’ in their typeKeywords.

Parameter	Description
save_folder	Optional string. Folder location to download the item’s metadata to.

Returns:

A file path, if the metadata download was successful. None if the item does not have metadata.

download_thumbnail(save_folder:str|None=None)

Thedownload_thumbnail method is similar to thedownload method but only downloads the item thumbnail.

Parameter	Description
save_folder	Optional string. Folder location to download the item’s thumbnail to.

return:

A file path, If the download was successful. None if the item does not have a thumbnail.

export(title:str,export_format:str,parameters:str|None=None,wait:bool=True,enforce_fld_vis:bool|None=None,tags:list[str]|str|None=None,snippet:str|None=None)

Theexport method is used to export a service item to the specified export format.However, it is available only to users with an organizational subscription and can only be invoked by theservice item owner or an administrator, unless a Location Tracking Service or Location Tracking View is used.Theexport method is useful for long running exports that could hold up a script.

Parameter	Description
title	Required string. The desired name of the exported service item.
export_format	Required string. The format to export the data to. Allowed types:Shapefile,CSV,File Geodatabase,Feature Collection,GeoJson,Scene Package,KML, Excel,geoPackage, orVector Tile Package.
parameters	Optional string. A JSON object describing the layers to be exportedand the export parameters for each layer.and the export parameters for each layer. SeeExport Itemin the REST API for guidance.
wait	Optional boolean. Default is True, which forces a wait for theexport to complete; use False for when it is okay to proceed whilethe export continues to completion.
enforce_fld_vis	Optional boolean. Be default when you are the owner of an item andtheexport operation is called, the data provides all the columns.If the export is being perform on a view, to ensure the view’scolumn definition is honor, then set the value to True. When theowner of the service and the value is set to False, all data andcolumns will be exported.
tags	Optional String. A comma seperated value of item descriptors.
snippet	Optional String. A short descriptive piece of text.

Returns:

AnItem object or a dictionary. Item is returned whenwait=True.A dictionary describing the status of the item is returned whenwait=False. See thestatus method for more information.

# Usage Example>>>item.export("hurricane_data","CSV",wait=True,tags="Hurricane, Natural Disasters")

propertyfavorite:bool

Gets/Sets if the Item is in the user’s favorites

generate_api_token(slot:int=1,regenerate:bool=False,expiration:datetime|None=None)→dict

Generates a Developer Token from an Developer Token Item.

Parameter	Description
slot	Optional int. API keys support 2 API tokens. Theslot allowsusers to specifiy which API Key to create or regenerate.
regenerate	Optional bool. When True, this will re-create the API token.The default is False.
expiration	Optional datetime.datetime. The time when the expiration expires.The maximum value is 1 year from the time you create the API Key.

Returns:

dict

get_data(try_json:bool=True)

Theget_data method retrieves the data associated with an item.

Note

This call may return different results for different item types: some item types may even returnNone. SeeWorking with users, groups, and itemsin the ArcGIS REST API for more information.

Parameter	Description
try_json	Optional string. Default is True. For JSON/text files, if try_jsonis True, the method tries to convert the data to a Python dictionary(use json.dumps(data) to convert the dictionary to a string),otherwise the data is returned as a string.

Returns:

Dependent on the content type of the data.For non-JSON/text data, binary files are returned and the path to the downloaded file.For JSON/text files, a Python dictionary or a string. All others will be a byte array,that can be converted to string using data.decode(‘utf-8’). Zero byte files will return None.

get_dependencies(deep:bool=False,outside_org:bool=False,out_format:str='item')

Gets the dependencies of theItem. The method can return the immediatedependencies, meaning otheritems the item contains in itsstructure, or the full deep dependency list, which contains allitems that must existfor theitem to function, including dependencies of dependencies.

Note

Not all items/item types have dependencies.

Parameter	Description
deep	Optional boolean. WhenTrue, everyitem needed for theitem to exist is contained in the result. WhenFalse, only immediate dependendencies of theitem or thosereferenced directy within the item’s structure are in the results.Default isFalse.
outside_org	Optional boolean. WhenTrue, the output list will includeitems from outsidetheGIS. Default isTrue. WhenFalse, onlyitems in the same organization as theitemare returned.
out_format	Optional string. Determines the format of the output list. Options: item - results areItem objects id, - results areitem id strings graph - result is an~arcgis.apps.itemgraph.ItemGraph object. Default isitem.

Returns:

A list containing the dependencies of the item either asitems, item id values, or anItemGraph.

get_thumbnail()

Theget_thumbnail method retrieves the bytes that make up the thumbnail for this item.

Returns:

Bytes that represent the item’s thumbnail.

Example

>>>response=item.get_thumbnail()>>>f=open(filename,'wb')>>>f.write(response)

get_thumbnail_link()

Theget_thumbnail_link method is similar to theget_thumbnail method, but retrieves the link to theitem’s thumbnail rather than the bytes that make up the thumbnail for this item.

Returns:

The link to the item’s thumbnail.

propertyhomepage

Thehomepage property gets the URL to the HTML page for the item.

propertyitem_card:str

Returns an XML representation of the Item

Returns:

A string path to the downloaded XML file.

propertymetadata

Themetadata property gets and sets the item metadata for the specified item.metadata returns None if the item does not have metadata.

Note

Items with metadata have ‘Metadata’ in their typeKeywords.

move(folder:str|Folder)

Themove method moves the current item to the name of the folder passed whenmove is called.

Parameter	Description
folder	Required string or Folder instance. The name of the folder to move the item to orthe Folder class instance representing this folder.Use ‘/’ for the root folder. For other folders, pass in thefolder name as a string, or a dictionary containing the folder ID,such as the dictionary obtained from the folders property.

Returns:

A json object in the following format:{“success”: true | false,“itemId”: “<item id>”,“owner”: “<owner username>”,“folder”: “<folder id>”}

# Usage Example>>>folder=gis.content.folders.get(folder="my folder")>>>item.move(folder)

package_info(folder:str|None=None)→str

Items will have a package info file available only if that item isan ArcGIS package (for example, a layer package or map package). Itcontains information that is used by clients (ArcGIS Pro, ArcGISExplorer, and so on) to work appropriately with downloadedpackages. Navigating to the URL will result in a package info file(.pkinfo) being downloaded.

Parameter	Description
folder	Optional string. The save location of the pkinfo file.

Returns:

str

protect(enable:bool=True)

Theprotect method enables or disables delete protection on this item, essentially allowing the item to bedeleted or protecting it from deletion.

Parameter	Description
enable	Optional boolean. Default is True which enables deleteprotection, False to disable delete protection.

Returns:

A json object in the following format:{“success”: true | false}

propertyproxies

Theproxies property gets the ArcGIS Online hosted proxy services, set on a registered app,item with the Registered App type keyword. Additionally, this resource is onlyavailable to the item owner and the organization administrator.

publish(publish_parameters:dict[str,Any]|None=None,address_fields:dict[str,str]|None=None,output_type:str|None=None,overwrite:bool=False,file_type:str|None=None,build_initial_cache:bool=False,item_id:str|None=None,geocode_service=None,future:bool=False)→Item|Future

Thepublish method is used to publish a hosted service based on an existing source item (this item).Publishers can then create feature, tiled map, vector tile and scene services.Feature services can be created from input files of various types, including

1. csv files

2. shapefiles

3. service definition files

4. feature collection files

5. file geodatabase files

CSV files that contain location fields (i.e. address fields or XY fields) are spatially enabled during the process of publishing.Shapefiles and file geodatabases should be packaged as*.zip files.

Tiled map services can be created from service definition (*.sd) files, tile packages, and existing feature services.

Vector tile services can be created from vector tile package (*.vtpk) files.

Scene services can be created from scene layer package (*.spk,*.slpk) files.

Service definitions are authored in ArcGIS Pro or ArcGIS Desktop and contain both the cartographic definition for a mapas well as its packaged data together with the definition of the geo-service to be created.

Note

ArcGIS does not permit overwriting if you published multiple hosted feature layers from the same data item.

Note

ArcGIS for Enterprise for Kubernetes does not support publishing service definition file generated by ArcMap.

Parameter	Description
publish_parameters	Optional dictionary. containing publish instructions and customizations.Cannot be combined with overwrite.SeePublish Itemin the ArcGIS REST API for details.
address_fields	Optional dictionary. containing mapping of df columns to address fields,
output_type	Optional string. Only used when a feature service is published as a tile service.
overwrite	Optional boolean. If True, the hosted feature service is overwritten.Only available in ArcGIS Enterprise 10.5+ and ArcGIS Online.
file_type	Optional string. Some formats are not automatically detected,when this occurs, the file_type can be specified:serviceDefinition, shapefile, csv, excel, tilePackage,featureService, featureCollection, fileGeodatabase, geojson,scenepackage, vectortilepackage, imageCollection, mapService,and sqliteGeodatabase are valid entries. This is anoptional parameter.
build_initial_cache	Optional boolean. The boolean value (default False), if trueand applicable for the file_type, the value will built cachefor the service.
item_id	Optional string. Available in ArcGIS Enterprise 10.8.1+. Not available in ArcGIS Online.This parameter allows the desired item id to be specified during creation whichcan be useful for cloning and automated content creation scenarios.The specified id must be a 32 character GUID string without any special characters. If theitem_id is already being used, an error will be raisedduring thepublish process.
geocode_service	Optional Geocoder. When publishing a table of data, an optionalGeocoder can be supplied in order to specify which servicegeocodes the information. If no geocoder is given, the firstregisteredGeocoder is used.
future	Optional Boolean indicating whether to run the operation in anasynchronous manner. WhenTrue, the return value is aconcurrent.futures.Future object that can be queried forjob status and results. The default isFalse.

Returns:

Whenfuture=False, anItem object corresponding to thepublished web layer. Whenfuture=True, aconcurrent.futures.Future object.

# Publishing a Hosted Table Example>>>csv_item=gis.content.get('<csv item id>')>>>analyzed=gis.content.analyze(item=csv_item,file_type='csv')>>>publish_parameters=analyzed['publishParameters']>>>publish_parameters['name']='AVeryUniqueName'# this needs to be updated>>>publish_parameters['locationType']="none"# this makes it a hosted table>>>published_item=csv_item.publish(publish_parameters)

# Publishing a Tile Service Example>>>item.publish(address_fields={"CountryCode":"Country"},>>>output_type="Tiles",>>>file_type="CSV",>>>item_id=9311d21a9a2047d19c0faaebd6f2cca6>>>)

Note

For publish_parameters, seePublish Itemin the ArcGIS REST API for more details.

propertyrating

Get/Set the rating given by the current user to the item.Set adds a rating to an item to which you have access - Only one ratingcan be given to an item per user. If this call is made on acurrently rated item, the new rating will overwrite the existingrating. A user cannot rate their own item. Available only toauthenticated users.

Parameter	Description
value	Required float. The rating to be applied for the item. The valuemust be a floating point number between 1.0 and 5.0.

reassign_to(target_owner:str|User,target_folder:str|None=None)

Thereassign_to method allows the administrator to reassign a single item from one user to another.

Note

If you wish to move all of a user’s items (and groups) to another user then use theuser.reassign_to() method. Theitem.reassign_to method (this method) only moves one item at a time.

Parameter	Description
target_owner	Required string orUser. The stringmust be ausername value.
target_folder	Optional string. The folder title to move the item to.

Returns:

A boolean indicating success (True) with the ID of the reassigned item, or failure (False).

# Usage Example>>>item.reassign_to("User1234")

register(app_type:str,redirect_uris:list[str]|None=None,http_referers:list[str]|None=None,privileges:list[str]|None=None,personal_token:bool|None=None)

Theregister method registers an app item with the enterprise, resulting in an APPID and APPSECRET(also known as client_id and client_secret in OAuth speak, respectively) beinggenerated for that app. Upon successful registration, a RegisteredApp type keyword gets appended to the app item.

Note

Theregister method is available to the item owner.

Parameter	Description
app_type	Required string. The type of app that was registered indicatingwhether it’s a browser app, native app, server app, or a multipleinterface app.Values: browser, native, server, or multiple
redirect_uris	Optional list. The URIs where the access_token or authorizationcode will be delivered upon successful authorization. Theredirect_uri specified during authorization must match one of theregistered URIs, otherwise authorization will be rejected. A special value ofurn:ietf:wg:oauth:2.0:oob can also be specifiedfor authorization grants. This will result in the authorizationcode being delivered to a portal URL (/oauth2/approval). Thisvalue is typically used by apps that don’t have a web server or acustom URI scheme where the code can be delivered. The value is a JSON string array.
http_referers	Optional List. A list of the http referrers for which usage of theAPIKey will be restricted to. Note Http Referrers can be configured for non apiKey type apps aswell. The list configured here will be used to validate the apptokens sent in while accessing the sharing API. The referrer checkswill not be applied to user tokens.
privileges	Optional List. A list of the privileges that will be available forthisAPIKey. Note Privileges can be configured for nonAPI Key type apps aswell. The list configured here will be used to grant access to itemswhen item endpoint is accessed with app tokens. The checks will notbe applied to user tokens and they can continue accessing itemsbased on the current item sharing model. With app tokens, all itemsof app owner can be accessed if the privileges list is notconfigured.
personal_token	Optional Boolean. When providing privileges that relate to anythingregarding operations on a user or administrative privileges, thismust be set to true, or else the token will not be generatedproperly.

Returns:

A dictionary indicating ‘success’ or ‘error’

# Usage Example>>>item.register(app_type="browser",>>>redirect_uris=["https://app.example.com","urn:ietf:wg:oauth:2.0:oob"],>>>http_referers=["https://foo.com","https://bar.com"],>>>privileges=["portal:apikey:basemaps","portal:app:access:item:itemId",>>>"premium:user:geocode","premium:user:networkanalysis"])

related_items(rel_type:str,direction:str='forward')

Therelated_items method retrieves the items related to this item. Relationships can be added and deletedusing item.add_relationship() and item.delete_relationship(), respectively.

Note

With WebMaps items, relationships are only available on local enterprises.

Parameter	Description
rel_type	Required string. The type of the related item; is one of[‘Map2Service’, ‘WMA2Code’, ‘Map2FeatureCollection’, ‘MobileApp2Code’,‘Service2Data’, ‘Service2Service’]. SeeRelationship Types in the REST API helpfor more information on this parameter.
direction	Required string. One of [‘forward’, ‘reverse’]

Returns:

The list of related items.

# Usage Example>>>item.related_items("Service2Service","forward")

remap_data(item_mapping:dict[str,str],force=False)

Method to help users easily replace data in web maps, applications, and other item typesthat may contain references to other items. Users pass in a dictionary of item idsspecifying the original item id and the item id of the item meant to replace it, and thefunction will automatically replace the id’s and other associated data with the item.Useful for workflows such as replacing corrupted datasources in an application withvalid ones, updating outdated datasources, replacing test data with production data,and more. Can be used by advanced users to replace any string in the item’s structure.

Parameter	Description
item_mapping	Required dict. A dictionary of the items to be remapped. The key isthe item id of the original item and the value is the item id of theitem meant to replace the original. Note This dictionary can also be used for regex replacements of otherstrings that are in the structure of the item (not just itemid’s), but only if theforce parameter is set toTrue. Thisis only recommended for advanced users with a thoroughunderstanding of their item’s data structure.
force	Optional boolean. IfFalse, the function will check if the itemids in theitem_mapping dictionary exist correspond to valid,accessible items item in the GIS, and that all original/replacementitem pairs are of matching type. IfTrue, the function will notcheck and replace all instances of theitem_mapping keys withtheir corresponding values in the item’s data. Default isFalse,is strongly recommended to remainFalse unless the user has aspecific reason to circumvent item id validation.

Returns:

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

# Usage Example 1: Replace web maps within an applicationstorymap=gis.content.get("storyid12345")# say we have a webmap with id 'webmapid12345' and want to replace it with anothermap_dict={"webmapid12345":"webmapid67890"}storymap.remap_data(map_dict)# Usage Example 2: Fix a typo everywhere in an itemdashboard=gis.content.get("dashboardid12345")# say we realized we've been spelling "arcgis" wrong this whole timerepl_dict={"arkgis":"arcgis"}dashboard.remap_data(repl_dict,force=True)

propertyresources

Theresources property returns the Item’s Resource Manager

Returns:

AResourceManager object

share(everyone:bool=False,org:bool=False,groups:list[Group]|list[str]|None=None,allow_members_to_edit:bool=False)

Deprecated since version 2.3.0:Removed in: 3.0.0. UseItem.sharing instead.

Deprecated since version 2.3.0:Removed in: 3.0.0. UseItem.sharing instead.

Theshare method allows you to set the list of groups the Item will be shared with.You can also set the Item to be shared with your org or with everyone(public including org).

Parameter	Description
everyone	Optional boolean. If True, this item will be shared witheveryone, meaning that it will be publicly accessible andavailable to users outside of the organization.If set to False (default), the item will not be sharedwith the public.
org	Optional boolean. If True, this item will be shared withthe organization. If set to False (default),the item will not be shared with the organization.
groups	Optional list of group ids as strings, or a list ofarcgis.gis.Group objects. Default is None, don’t sharewith any specific groups.
allow_members_to_edit	Optional boolean. Set to True when the item will be sharedwith groups with item update capability so that any memberof such groups can update the item that is shared with them.

Returns:

A dictionary with a key titled “notSharedWith”,containing array of groups with which the item could not beshared as well as “itemId” key containing the item id.

# Usage Example>>>item.share(org=True,allow_members_to_edit=True)

propertyshared_with

Deprecated since version 2.3.0:Removed in: 3.0.0. UseItem.sharing instead.

Deprecated since version 2.3.0:Removed in: 3.0.0. UseItem.sharing instead.

Theshared_with property reveals the privacy or sharing status of the current item. An item can be privateor shared with one or more of the following:

1. A specified list of groups

2. All members in the organization

3. Everyone (including anonymous users).

Note

If the return is False fororg,everyone and contains an empty list ofgroups, then theitem is private and visible only to the owner.

Returns:

A Dictionary in the following format:{‘groups’: [], # one or more Group objects‘everyone’: True | False,‘org’: True | False}

propertysharing:SharingManager

Thesharing property accesses aSharingManagerobject to allow users and administrators to control how the currentItem is shared throughout theGIS.

Returns:

SharingManager

# Usage example:>>>gis=GIS(profile="your_organization_admin_profile")>>>an_item=gis.content.get("<item_id>")>>>sharing_mgr=an_item.sharing>>>sharing_mgr<<item_id>SharingManager>

propertysnapshots:list

Thesnapshots property provides access to the Notebook Item’s Snapshots. If the user is notthe owner of theItem, the snapshots will be an empty list.

Returns:

List[SnapShot]

status(job_id:str|None=None,job_type:str|None=None)

Thestatus method provides the status of anItem in the following situations:

1. Publishing anItem

2. Adding anItem in async mode

3. Adding with a multipart upload.Partial is available forAddItemMultipart when only a part isuploaded and theItem object is not committed.

Parameter	Description
job_id	Optional string. The job ID returned during publish, generateFeatures,export, and createService calls.
job_type	Optional string. The type of asynchronous job for which the statushas to be checked. Default is none, which checks the item’s status.This parameter is optional unless used with the operations listedbelow. Values:publish,generateFeatures,export, andcreateService

Returns:

The status of a publishingItem object.

# Usage Example>>>item.status(job_type="generateFeatures")

unregister()

Theunregister property removes the application registration from an appItem, along with the Registered App type keyword.

Note

Theunregister method is available to the item owner and organization administrators.

Returns:

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

unshare(groups:list[str]|list[Group])

Deprecated since version 2.3.0:Removed in: 3.0.0. UseItem.sharing instead.

Deprecated since version 2.3.0:Removed in: 3.0.0. UseItem.sharing instead.

Theunshare method stops sharing of the Item with the specified list of groups.

Parameter	Description
groups	Optional list of group names as strings, or a list ofGroup objects,or a comma-separated list of group IDs.

Returns:

A Dictionary containing the keynotUnsharedFrom containing array of groups from which the itemcould not be unshared.

update(item_properties:dict[str,Any]|None|ItemProperties=None,data:str|None=None,thumbnail:str|None=None,metadata:str|None=None)

Theupdate method updates an item in a Portal.

Note

The content can be a file (such as a layer package, geoprocessing package,map package) or a URL (to an ArcGIS Server service, WMS service,or an application).

To upload a package or other type of file, a path or URLto the file must be provided in the data argument.

For item_properties, pass in arguments for only the properties you want to be updated.All other properties will be untouched. For example, if you want to update only theitem’s description, then only provide the description argument in item_properties.

Parameter	Description
item_properties	Required dictionary. See table below for the keys and values.
data	Optional string, io.StringIO, or io.BytesIO. Either a path or URL tothe data or an instance ofStringIO orBytesIO objects.
thumbnail	Optional string. Either a path or URL to a thumbnail image.
metadata	Optional string. Either a path or URL to the metadata.

Key:Value Dictionary Options for Argument item_properties

Key	Value
type	Optional string. Indicates type of item, see the link below for valid values.
typeKeywords	Optional string. Provide a lists all sub-types, see the link below for valid values.
description	Optional string. Description of the item.
title	Optional string. Name label of the item.
url	Optional string. URL to item that are based on URLs.
tags	Optional string. Tags listed as comma-separated values, or a list of strings.Used for searches on items.
text	Optional string. For text based items such as Feature Collections & WebMaps
snippet	Optional string. Provide a short summary (limit to max 250 characters) of the what the item is.
extent	Optional string. Provide comma-separated values for min x, min y, max x, max y.
spatialReference	Optional string. Coordinate system that the item is in.
accessInformation	Optional string. Information on the source of the content.
licenseInfo	Optional string. Any license information or restrictions regarding the content.
culture	Optional string. Locale, country and language information.
access	Optional string. Valid values are private, shared, org, or public.

Note

SeeItems and Item Typesin the ArcGIS REST API documentation for more details.

Returns:

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

# Usage Example>>>item.update(item_properties={"description":"Boundaries and infrastructure for Warren County","title":"Warren County Feature Layer","tags":"local government, administration, Warren County"})

update_info(file:str,folder_name:str|None=None)

You can upload JSON, XML, CFG, TXT, PBF, and PNG files only. The file size limit is 100K.The uploaded file is also available through thehttps://item-url/info/filename resource.

Must be the owner of the item to update this.

Parameter	Description
file	Required String. The path to the file that will be uploaded.
folder_name	Optional String. The name of the subfolder for added information.

Returns:

Success or Failure

update_thumbnail(file_path:str|None=None,encoded_image:str|None=None,file_name:str|None=None,url:str|None=None)→bool

Theupdate_thumbnail updates the thumbnail of any ArcGIS item in your organization. The updated thumbnailcan be provided in a variety of formats, as either a file to be uploaded as part of a multipart request,a direct URL to the thumbnail file, or as a Base64 encoded image.

Parameter	Description
file_path	Optional String. The local path to the thumbnail.
encoded_image	Optional String. A base64 encoded image as a string.
file_name	Optional String. This is required withencoded_image is used. It is the name of the filewith extension. Example thumbnail.png
url	Optional String. A URL location of a thumbnail.

# Usage Example 1: Using a base64 encoded imagegis=GIS(profile='your_profile')item=gis.content.get(<itemid>)base64_img=('data:image/png;base64,''iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAACXBIWXMAAAsTAAA''LEwEAmpwYAAAB1klEQVQ4jY2TTUhUURTHf+fy/HrjhNEX2KRGiyIXg8xgSURuokX''LxFW0qDTaSQupkHirthK0qF0WQQQR0UCbwCQyw8KCiDbShEYLJQdmpsk3895p4aS''v92ass7pcfv/zP+fcc4U6kXKe2pTY3tjSUHjtnFgB0VqchC/SY8/293S23f+6VEj''9KKwCoPDNIJdmr598GOZNJKNWTic7tqb27WwNuuwGvVWrAit84fsmMzE1P1+1TiK''MVKvYUjdBvzPZXCwXzyhyWNBgVYkgrIow09VJMznpyebWE+Tdn9cEroBSc1JVPS+''6moh5Xyjj65vEgBxafGzWetTh+rr1eE/c/TMYg8hlAOvI6JP4KmwLgJ4qD0TIbli''TB+sunjkbeLekKsZ6Zc8V027aBRoBRHVoduDiSypmGFG7CrcBEyDHA0ZNfNphC0D''6amYa6ANw3YbWD4Pn3oIc+EdL36V3od0A+MaMAXmA8x2Zyn+IQeQeBDfRcUw3B+2''PxwZ/EdtTDpCPQLMh9TKx0k3pXipEVlknsf5KoNzGyOe1sz8nvYtTQT6yyvTjIax''smHGB9pFx4n3jIEfDePQvCIrnn0J4B/gA5J4XcRfu4JZuRAw3C51OtOjM3l2bMb8''Br5eXCsT/w/EAAAAASUVORK5CYII=')res=item.update_thumbnail(encoded_image=base64_img,file_name="thumbnail.png")

# Usage Example 2: URL imagegis=GIS(profile='your_profile')item=gis.content.get(<itemid>)img_url="https://www.esri.com/content/dam/esrisites/en-us/common/icons/product-logos/ArcGIS-Pro.png"res=item.update_thumbnail(url=img_url)

# Usage Example 3: Using a local filegis=GIS(profile='your_profile')item=gis.content.get(<itemid>)fp="c:/images/ArcGIS-Pro.png"res=item.update_thumbnail(file_path=fp)

Returns:

bool

usage(date_range:str='7D',as_df:bool=True)

Note

Theusage method is available for ArcGIS Online Only.

For item owners and administrators, theusage method provides usage details about an item that help yougauge its popularity. Usage details show how many times the item has been used for the timeperiod you select. Historical usage information is available for the past year. Depending onthe item type, usage details can include the number of views, requests, or downloads, andthe average number of views, requests, or downloads per day.

Views refers to the number of times the item has been viewed or opened. For maps, scenes,non-hosted layers, and web apps, the view count is increased by one when you open the itempage or open the item in Map Viewer. For example, if you opened the item page for a mapimage layer and clicked Open in Map Viewer, the count would increase by two. For other itemssuch as mobile apps, KML, and so on, the view count is increased by one when you open theitem; the count does not increase when you open the item details page.

For hosted web layers (feature, tile, and scene), the number of requests is provided insteadof views. Requests refers to the number of times a request is made for the data within thelayer. For example, someone might open an app that contains a hosted feature layer. Openingthe app counts as one view for the application, but multiple requests may be necessary todraw all the features in the hosted layer and are counted as such.

For downloadable file item types such as CSV, SHP, and so on, the number of downloads isdisplayed. For registered apps, the Usage tab also displays the number of times users havelogged in to the app. Apps that allow access to subscriber content through the organizationsubscription show usage by credits. Additionally, the time frame for the credit usagereporting period can be changed.

Parameter	Description
date_range	Optional string. The default is 7d. This is the period to queryusage for a given item. 24H Past 24 hours 7D Past 7 days (default) 14D Past 14 days 30D Past 30 days 60D Past 60 days 6M Past 6 months 1Y Past 12 months (date1,date2) Tuple of 2 datetimeobjects defining customdate range
as_df	Optional boolean. Returns a Pandas DataFrame when True, returns dataas a dictionary when False

Returns:

PandasDataFrame or Dictionary

# Usage Example #1: Standard date_range>>>flyr_item=gis.content.get("8961540a52da402876e0168fa29bb82d")>>>result=flyr_item.usage(date_range="7D")DateUsage02022-08-05012022-08-06022022-08-07032022-08-08042022-08-09052022-08-10062022-08-11072022-08-128# Usage Example #2: Custom date_range>>>importdatetimeasdt>>>flyr_item=gis.content.get("8961540a52da402876e0168fa29bb82d")>>>date_1=dt.datetime(2022,7,31)>>>date_2=dt.datetime.now(2022,8,12)# Early value, later value>>>result=flyr_item.usage(date_range=(date_1,date_2))>>>resultDateUsage02022-07-31012022-08-01022022-08-02032022-08-03042022-08-04052022-08-05062022-08-06072022-08-07082022-08-08092022-08-090102022-08-100112022-08-110122022-08-1210

propertyview_manager:ViewManager|None

If theItem is aFeature Service and aHosted Service, theItemcan have views. This Manager allows users to work withFeature Serviceto createviews

Returns:

AViewManager object to administer hostedfeature layer viewitems created fromthe hosted feature layer.

Bases:object

Manages the sharing operations for anItem.

This class is not meant to be initialized directly. An instance of aSharingManager is available through thesharingproperty of anitem.

# Usage example:>>>gis=GIS(profile="your_organization_profile",verify_cert=False)>>>test_item=gis.content.get("4976ad...b9583e")>>>sharing_mgr=test_item.sharing<"4976ad...b9583e"SharingManager>>>>type(sharing_mgr)<class'arcgis.gis._impl._content_manager.sharing.api.SharingManager'>

propertygroups:SharingGroupManager

Provides access to aSharingGroupManagerobject to manage thegroup sharing properties of theItem from which theSharingManager wasinitialized

Returns:

SharingGroupManagerobject

propertyshared_with:dict[str,Any]

Theshared_with property reveals the sharing status withgroups and the sharing levelof theItem. Anitem can be private to its owner,or shared in one or more of the following ways:

• to a specified list of groups

• to all members in the organization

• to everyone (including anonymous users), aka publicly

Returns:

dict[str,Any]. A dictionary describing the sharing level.

# Usage example: Item only visible to the owner.>>>fromarcgis.gisimportGIS>>>gis=GIS(profile="your_organization_profile")>>>data_item=gis.content.get("269029...2c482e")>>>data_item.sharing.shared_with{'groups':[],'level':<SharingLevel.PRIVATE:'PRIVATE'>}

propertysharing_level:SharingLevel

Gets or sets the sharing level of theItem.

Returns:

SharingLevelenumeration instance.

# Usage example: Setting the sharing level to organization>>>fromarcgis.gisimportGIS,SharingLevel>>>data_item=gis.content.search(query="Hurricanes 2022")>>>sharing_mgr=data_item.sharing>>>sharing_mgr.sharing_level<SharingLevel.PRIVATE:'PRIVATE'>>>>sharing_mgr.sharing_level=SharingLevel.ORG>>>sharing_mgr.sharing_level<SharingLevel.ORG:'ORGANIZATION'>>>>type(sharing_mgr.sharing_level)<enum'SharingLevel'>

Bases:object

This class controls theGroup sharing for a specificItem.

Objects of this class are not meant to be initializeddirectly, but rather accessed through thegroupsproperty of anitem’sSharingManager.

# Usage example:>>>fromarcgis.gisimportGIS>>>gis=GIS(profile="your_organization_profile")>>>org_item=gis.content.get("<item_id>")>>>item_sharing_mgr=org_item.sharing>>>item_grp_sharing_mgr=item_sharing_mgr.groups>>>item_grp_sharing_mgr<<item_id>SharingGroupManager>>>>type(item_grp_sharing_mgr)<class'arcgis.gis._impl._content_manager.sharing.api.SharingGroupManager'>

add(group:Group|str)→bool

Shares anItem with theGroupentered as thegroup argument.

Parameter	Description
group	RequiredGroup object to share theitemwith.

Returns:

Boolean value indicating the status of the operation.

# Usage example:>>>fromarcgis.gisimportGIS>>>gis=GIS(profile="your_organization_profile")>>>org_item=gis.content.get("<item_id>")>>>org_group=gis.groups.search("Storm Data Group")[0]>>>item_sharing_mgr=org_item.sharing>>>item_grp_sharing_mgr=item_sharing_mgr.groups>>>item_grp_sharing_mgr.list()[]>>>item_grp_sharing_mgr.add(group=org_group)True>>>item_grp_sharing_mgr.list()[<Grouptitle:"Storm Data Group"owner:web_gis_user1>]

list()→list[Group]

Lists all thegroups that theitem isshared with.

Returns:

list[Group]A Python list ofgroup objects.

remove(group)→bool

Removes theitem from the list ofitems shared with theGroup entered as thegroup argument.

Parameter	Description
group	RequiredGroup object with which theitem will no longer be shared.

Returns:

Boolean value indicating the status of the operation.

Bases:object

Manage, monitor, and control Item dependencies.

Dependencies allow users to better understand the relationships betweentheir organizational items. This class provides the users with the following:

• Warnings during item deletion if the deletion is going to break item/layer references in a web map or web application.

• Ability to explore the dependents and dependencies of a specific item.

• Administrator ability to efficiently update the URLs of their hosted/federated services in a single edit operation.

When an item is updated, its dependencies are updated as well and always be kept in sync.

add(depend_type:str,depend_value:str)

Assigns a dependency to the current item

Parameter	Description
depend_type	Required String. This is the type of dependency that is registeredfor the item. Allowed values: table url itemid serverId
depend_value	Required string. This is the associated value for the type above.

Returns:

Boolean

propertyproperties

returns the dependencies properties

remove(depend_type:str,depend_value:str)

Deletes a dependency to the current item

Parameter	Description
depend_type	Required String. This is the type of dependency that is registeredfor the item. The allowed values are: table, url, or itemid.
depend_value	Required string. This is the associated value for the type above.

Returns:

Boolean

remove_all()

Revokes all dependencies for the current item

Returns:

Boolean

propertyto_dependencies

Returns a list of items that are dependent on the current Item

Bases:dict

TheUser class represents a registered user of the GIS system, either ArcGIS Online or ArcGIS Enterprise. TheUser class has a myriad of properties that are specific to a particular user - these properties areenumerated in the table below.

propertybundles

Thebundles method provides the current user’s assigned application bundles.

Note

Thebundles method is available in ArcGIS Online and Portal 10.7+.

Returns:

A List ofBundle objects

delete(reassign_to:str|User=None)

Thedelete method deletes this user from the portal, optionally deleting or reassigning groups and items.

Note

You can not delete a user in Portal if that user owns groups or items and/or isassigned an application bundle. If you specify a user in the reassign_toargument, then items and groups will be transferred to that user. If thatargument is not set, the method will fail provided the user has items or groupsthat need to be reassigned. Additionally, see thereassign_to method for moreinformation on reassignment.

Parameter	Description
reassign_to	Optional string. The new owner of the items and groupsthat belong to the user being deleted.

# Usage Exampleuser.delete(reassign_to="User1234")

Returns:

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

delete_thumbnail()

Thedelete_thumbnail removes the thumbnail from the user’s profile.

Returns:

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

disable()

Thedisable method disables login access for the user.

Note

Thedisable method is only available to the administrator of the organization.

Returns:

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

download_thumbnail(save_folder:str|None=None)

Thedownload_thumbnail method downloads the item thumbnail for this user and saves it in the folder thatis passed whendownload_thumbnail is called.

Parameter	Description
save_folder	Optional string. The desired folder name to download the thumbnail to.

Returns:

The file path of the downloaded thumbnail.

enable()

Theenable method enables login access for the user.

Note

enable is only available to the administrator of the organization.

propertyesri_access

Theesri_access property will return a string describing the current user’s Esri access.When setting, supply aboolean to enable or disableesri_access for thatUserobject.

Note

Administrator privileges are required to enable or disable Esri access

A member whose account has Esri access enabled can use My Esri andCommunity and Forums (GeoNet), access e-Learning on the Trainingwebsite, and manage email communications from Esri. The membercannot enable or disable their own access to these Esri resources.

Warning

Trial accounts cannot modify esri_access property.

Please see theEnable Esri accesssection in the Manage members page in ArcGIS Online Resources for more information.

Parameter	Description
value	Required boolean. The current user will be allowed to usethe username for other Esri/ArcGIS logins when the valueis set to True. If false, the account can only be used toaccess a given individual’s organization.

expire_password(temporary_password:str|None=None)→bool

Expires the current user’s Password.

Parameter	Description
temporary_password	Optional String. Allows the administrator to set a newtemporary password for a given user. This is available onArcGIS Enterprise Only.

Returns:

Boolean

propertyfolders:Iterator[Folder]

Creates a generator to iterate overFolder objectsfor the user.

Returns:

Python generator to iterate over the user’sfolders.

# Example to get a generator>>>gis=GIS(profile="your_web_gis_profile")>>>gis_user=gis.users.me>>>folder_gen=gis_user.folders>>>type(folder_gen)<class'generator'>>>>forfldrinfolder_gen:>>>print(fldr.name)RootFolderWater_Data...Streets_folder# Example to get a list of dictionary representations for each folder>>>folders_dict_list=[f.propertiesforfinlist(folder_gen)]>>>folders_dict_list[{'id':'Root Folder','name':'Root Folder'},{'username':'gis_user','id':'2e89 ... c26a34018a62','title':'Water_Data','created':1676505498100},...{'username':'gis_user','id':'d2e ... 7edc','title':'air_quality_data','created':1719858924000}]