build_collector_url

arcgis.apps.build_collector_url(webmap=None,center=None,feature_layer=None,fields=None,search=None,portal=None,action=None,geometry=None,callback=None,callback_prompt=None,feature_id=None)

Deprecated since version 2.4.0:Removed in: 2.5.0. Use build_field_maps_url instead.

Deprecated since version 2.4.0:Removed in: 2.5.0. Use build_field_maps_url instead.

Creates a url that can be used to open ArcGIS Collector

Parameter	Description
webmap	OptionalString,Map,Item.The item id, webmap, or item representing the map to open in Collector.
center	OptionalString,list,tuple.The “lat,long” in WGS84 of where to center the map
feature_layer	OptionalString orFeatureLayer.The feature layer url as string or the feature layer representing the layer to openfor collection.
fields	OptionalDict. The feature attributes dictionary {“field”:”value”}
search	OptionalString An address, place, coordinate, or feature to search forRequires webmap and action=search to be set.Value must be URL encoded
portal	OptionalString,GIS.The URL of the portal the mobile worker must be connected to.
action	OptionalString What the app should do, if anything, once openand the user is signed in.The following values are supported: addFeature, center, open, search, updateFeature.
geometry	OptionalString. Defines the location for the newly collectoedor edited featureRequires webmap, action=addFeature, and feature_layer.Value is a coordinate containing x, y (z if available)
callback	OptionalString. The URL to call when capturing the asset orobservation is complete.Requires webmap, action=addFeature, and feature_layer to be set.Optionally, before calling the URL provide a prompt for the user,specified with the callback_prompt parameter.
callback_prompt	OptionalString. Prompt the mobile worker before executing the callback,and display this value in the prompt as where the mobile worker will be taken.Requires webmap, action=addFeature, feature_layer, and callback to be specified.Value must be URL encoded

Returns:

String

build_explorer_url

arcgis.apps.build_explorer_url(webmap=None,search=None,bookmark=None,center=None,scale=None,wkid=None,rotation=None,markup=None,url_type='Web')

Deprecated since version 2.4.0:Removed in: 2.5.0. Use build_field_maps_url instead.

Deprecated since version 2.4.0:Removed in: 2.5.0. Use build_field_maps_url instead.

Creates a url that can be used to open ArcGIS Explorer

Parameter	Description
webmap	OptionalString,Map,Item.The item id, webmap, or item representing the map to open in Explorer.Item can be of type Web Map or Mobile Map Package.
search	OptionalString. The location to search for.
bookmark	OptionalString. The name of the bookmark in the map to open.
center	OptionalString,list,tuple.The “lat,long” in WGS84 of where to center the map
scale	OptionalInt. The scale at which to open the map.
rotation	OptionalInt. The rotation, in degrees, at which to open the map.
markup	OptionalBoolean. Determines if the app should open in markup mode.
url_type	OptionalString. The type of url to be returned (e.g. ‘Web’ or ‘App’)

Additional info can be found here:https://github.com/Esri/explorer-integration

Returns:

String

build_field_maps_url

arcgis.apps.build_field_maps_url(portal=None,action=None,webmap=None,scale=None,bookmark=None,wkid=None,center=None,search=None,feature_layer=None,fields=None,geometry=None,use_antenna_height=None,use_loc_profile=None,feature_id=None,callback=None,callback_prompt=None,anonymous=None)

Creates a url that can be used to open ArcGIS Field Maps

Parameter	Description
portal	OptionalString,GIS.The URL of the portal the mobile worker must be connected to.
action	OptionalString What the app should do, if anything, once openand the user is signed in. This correlates to the URL param “referenceContext”The following values are supported: addFeature, center, open, search, updateFeature.
webmap	OptionalString,Map,Item.The item id, webmap, or item representing the map to open in Field Maps.Item can be of type Web Map or Mobile Map Package.
scale	OptionalInt. The scale at which to open the map. Requires center.
bookmark	OptionalString. The name of the bookmark in the map to open.
wkid	OptionalString. The WKID of the spatial reference. Defaultsto 4326 (WGS84) if not specified
center	OptionalString,list,tuple.Requires itemID and scale.The center can be provided in the following formats:- Comma-separated latitude/longitude (y/x) pair in WGS84 (WKID: 4326).- Address to be reverse geocoded by the organization’s default geocoder(MMPKs with locators will not utilize geocoder).- Feature search result. Field Maps will automatically center on the top search result.
search	OptionalString. The location to search for.
feature_layer	OptionalString orFeatureLayer.The feature layer url as string or the feature layer representing the layer to openfor collection.
fields	OptionalDict. The feature attributes dictionary {“field”:”value”}
geometry	OptionalString orDict. Defines the location for the newly collectoedor edited featureRequires webmap, action=addFeature, and feature_layer.Value is a coordinate containing x, y (z if available) or JSON representation of a geometry(point line or polygon)For example “34.058030,-117.195940,1200” or{“rings”:[[[-117.1961714,34.0547155],[-117.1961714,34.0587155],[-117.2001714,34.0587155],[-117.2001714,34.0547155]]], “spatialReference”:{“wkid”:4326}}
use_antenna_height	Optionalbool. If the antenna height of the current receivershould be subtracted from the z-value of each vertex of the location. If not provided,default to False
use_loc_profile	Optionalbool. If the current location profile should be used totransform the location. If not provided, default to False
feature_id	OptionalString. Uniquely identifies the feature within the layer to be updated.Must be a GlobalID field.
callback	OptionalString. The URL to call when capturing the asset orobservation is complete.Requires webmap, action=addFeature or updateFeature, and feature_layer to be set.Optionally, before calling the URL provide a prompt for the user,specified with the callback_prompt parameter.
callback_prompt	OptionalString. Prompt the mobile worker before executing the callback,and display this value in the prompt as where the mobile worker will be taken.Requires webmap, action=addFeature or updateFeature, feature_layer, and callback to be specified.
anonymous	Optionalbool. Used when calling amap or mmpk that is shared publicly and will not require asign-in to access. Accepts values of true or false.

Returns:

String

build_navigator_url

arcgis.apps.build_navigator_url(start=None,stops=None,optimize=None,navigate=None,travel_mode=None,callback=None,callback_prompt=None,url_type='Web',webmap=None,route_item=None)

Creates a url that can be used to open ArcGIS Navigator

Parameter	Description
start	OptionalString orTuple. The starting location.Can be a single string such as ‘45,-77’ or a tuple containing thelocation and the name (‘45,-77’,’Home’)
stops	OptionalList. The list of locations. A location can be eithera single string or a tuple containing the location and thename (‘45,-77’, ‘Home’).
optimize	OptionalBoolean. Determines if the route should be optimized.
navigate	OptionalBoolean. Determines if navigation should begin immediately.
travel_mode	OptionalString. The travel mode to use (e.g. ‘Walking Time’)
callback	OptionalString. The url to open when the route completes.
callback_prompt	OptionalString. The text to show when the route finishes and thecallback is about to be invoked.
url_type	OptionalString. The type of url to be returned (e.g. ‘Web’ or ‘App’)
webmap	OptionalString,Item.The item id or item representing the map to open in Navigator.Item can be of type Mobile Map Package.
route_item	OptionalString,Item.The item id or item representing the route layer to open.

Additional info can be found here:https://github.com/Esri/navigator-integration

Returns:

String

build_survey123_url

arcgis.apps.build_survey123_url(survey=None,center=None,fields=None)

Creates a url that can be used to open ArcGIS Survey123

Parameter	Description
survey	OptionalString orItem. The item id oritem representing the survey to open.
center	OptionalString. The “lat,long” in WGS84 of where to center the map
fields	OptionalDict. The feature attributes dictionary {“field”:”value”}

Additional info can be found here:https://doc.arcgis.com/en/survey123/reference/integratewithotherapps.htm

Returns:

String

build_tracker_url

arcgis.apps.build_tracker_url(portal_url=None,url_type='Web')

Deprecated since version 2.4.0:Removed in: 2.5.0. Use build_field_maps_url instead.

Deprecated since version 2.4.0:Removed in: 2.5.0. Use build_field_maps_url instead.

Creates a url that can be used to open ArcGIS Tracker

Parameter	Description
portal_url	OptionalString The portal that should be used when trackeris launched via the url scheme.
url_type	OptionalString. The type of url to be returned (e.g. ‘Web’ or ‘App’)

Returns:

String

build_workforce_url

arcgis.apps.build_workforce_url(portal_url=None,url_type='Web',webmap=None,assignment=None,assignment_status=None)

Creates a url that can be used to open ArcGIS Workforce

Parameter	Description
portal_url	OptionalString The portal that should be used when Workforceis launched via the url scheme.
url_type	OptionalString. The type of url to be returned (e.g. ‘Web’ or ‘App’)
webmap	OptionalString,Map,Item.The item id, webmap, or item representing the map to open in Workforce.Item can be of type Web Map. This can be referencedat the project level using project.worker_webmap
assignment	OptionalString,Assignment.The assignment or assignment global id that should be opened in Workforce.Note that webmap must be provided for this parameter to be added to the URL.
assignment_status	OptionalIntegerThe status given to an assignment opened in Workforce. Statuses 1-5are supported (Assigned, In Progress, Completed, Declined, Paused).Note that webmap and assignment must be provided for this parameter to beadded to the URL.

Returns:

String

Submodules