Common parameters—REST APIs | Documentation for ArcGIS Enterprise

Parameters common to all operations

The parameters listed in the following table are common to all REST API operations, unless otherwise noted:


Parameter	Details
token	Generated by the generateToken call, an access token that identifies the authenticated user and controls access to restricted resources and operations. Example `token=sRLRIZKu6JxQRC2XVLwgbHMGLsRIFrpA1yEhgUX36_tGpKmtk4fNSrYxleaWxHPJ`
f	The output format can be HTML, JSON, or PJSON. The default is HTML. Search and item comments support RSS as an output format. Values: html \| json \| pjson Example `f=json`
callback	Callback is used for JavaScript clients that need a response. Example request `https://www.arcgis.com/sharing/rest/community/users/jsmith/notifications?f=json&token=sRLRIZKu6JxQRC2XVLwgbHMGLsRIFrpA1yEhgUX36_tGpKmtk4fNSrYxleaWxHPJ&callback=dojo.io.script.jsonp_dojoIoScript1._jsonpCallback` Example response `dojo.io.script.jsonp_dojoIoScript1._jsonpCallback({"notifications":[]});`

Item parameters

Item parameters correspond to properties of an item that are available to update on the Add Item and Update Item operations.


Parameter	Details
title	The title of the item. This is the only name that users and applications use for the item. There is no concept of display names or aliases in the ArcGIS Portal Directory REST API. Example `title=Landmarks`
thumbnail	Enter the path to the thumbnail image to be used for the item. For best results, images that are 600 pixels wide by 400 pixels high or larger with an aspect ratio of 1.5:1 are recommended. Supported file formats are PNG, GIF, and JPEG with a maximum file size of 10 MB. This will not be a reference to the file but the file itself that is stored on the sharing servers. Item thumbnails can be retrieved at different dimensions by specifying a URL parameter w for the desired image width: Example `https://www.arcgis.com/sharing/rest/content/items/[itemid]/info/thumbnail/thumbnail.png?w=400` Supported retrievable thumbnail widths for items are 200 pixels (default), 400 pixels, 800 pixels, and 2400 pixels, with an aspect ratio of 1.5:1. Other specified sizes will be snapped to the next highest supported dimension for query. If the original image dimension is smaller than the size queried, the original image will be returned. Example `thumbnail=subfolder/thumbnail.jpg`
thumbnailurl	Enter the URL to the thumbnail image to be used for the item. The recommended image size is 200 pixels wide by 133 pixels high. Acceptable image formats are PNG, GIF, and JPEG. The maximum file size for an image is 1 MB. Example `thumbnailurl=https://server/arcgis/subfolder/thumbnail.jpg`
metadata	The file that stores the metadata information on an item. It's stored in the metadata folder under esriinfo, for example, /sharing/rest/content/items/<itemid>/info/metadata/metadata.xml. Example `metadata=metadata.xml`
metadataEditable	Indicates whether the organization has metadata enabled. If metadataEditable=true, all members of the organization can view the metadata. Only item owners and administrators can update metadata. If metadataEditable=false, no one in the organization can access the metadata. Values: true \| false
metadataFormats	Metadata style used for organization. Default is iso19139. Values: fgdc \| inspire \| iso19139 \| iso19139-3.2 \| iso19115 Example: metadataFormats : iso19139-3.2
type	The type of the item. Must be drawn from the list of supported types. See Items and item types for a list of the supported types. Note: The parameter is not applicable to Update Item operation. Example `type=Web Mapping Application`
typeKeywords	Type keywords describe the type and should logically apply to all items of that type. See Items and item types for a list of the different predefined type keywords that will be automatically added based on the supplied type. Use this parameter only if you want to add additional type keywords. typeKeywords can be applied to any type of item, in addition to hosted feature services. Syntax `typeKeywords=<keyword1>, <keyword2>` Example `typeKeywords=Static`
description	An item description less than 64 Kb. Example `description=This application represents point locations within the United States and Canada for common institution landmark types including hospitals, educational institutions, religious institutions, government centers, and cemeteries.`
tags	Tags are words or short phrases that describe the specific item. Separate with commas. Syntax `tags=<tag1>, <tag2>` Example `tags=landmarks, United States, Canada`
snippet	Snippet or summary for the item. Limit this brief descriptive text to 2048 characters. Example `snippet=Landmarks in United States and Canada.`
extent	The bounding rectangle of the item. Example `extent=<xmin>, <ymin>, <xmax>, <ymax>` Example `extent=-110.05, 44.13, -110, 44.98`
spatialReference	The coordinate system of the item. Example `spatialReference=GCS_North_American_1983` Note: If the extent of the data can be reprojected, the spatialReference should always be WGS84. Otherwise, native projection can be used. This applies even if the data or layer is in another projection. WGS84 is recommended when possible. The coordinate system should always be WKID. WKT can be used only if WKID is not available.
accessInformation	Credits the source of the item. Example `accessInformation=Copyright:© 2008 ESRI, AND, TANA, ESRI Japan, UNEP-WCMC`
licenseInfo	Includes any license information or restrictions. Example `licenseInfo=This work is licensed under a Creative Commons Attribution-Noncommercial-Share Alike 3.0 United States License`
culture	The item locale (language and country) information. When adding a new item, the following apply: If the item is a package, the culture parameter on the ESRI_ItemInformation tag is read and used if available. If the user provides a culture property to the addItem call, this is used (and overwrites what's in the package if present). If the culture is not specified by the user or provided in a package, the culture is set using the Accept-Language HTTP header sent by the browser. If the browser does not provide a locale, no default is set. The record will have no locale, and it will not be indexed under a certain language or country. When updating an item, the following apply: If the user provides a culture property to updateItem, it will be used to update the culture parameter. For an update, the browser locale will not be taken into consideration. The format for a culture code is based on a language code and a country code separated by a dash: The language code is based on the two-letter codes found at the Library of Congress Codes for the Representation of Names of Languages page. The country code is based on the two-letter codes found by searching the ISO Online Browsing Platform. Example: en
properties	A JSON object that primarily applies to system requirements, terms and conditions, version, supported platforms, YouTube video ID, and so on associated with the application.
appCategories	An array that primarily applies to a list of categories that the application item is applicable to.
industries	An array that primarily applies to industries associated with the application.
languages	An array that primarily applies to languages associated with the application.
largeThumbnail	Primarily applies to the thumbnail associated with an application. This is the URL to the thumbnail used for the application.
banner	Primarily applies to the banner associated with an application. This is the URL to the banner used for the application.
screenshot	An array that primarily applies to screenshots associated with an application. This is the URL to the screenshots used for the application.
listingProperties	A JSON object consists of listing properties when the item is listed in ArcGIS Marketplace. For detailed syntax and properties, see Listing properties.
serviceUsername	Sets the username on a secure on-premises ArcGIS Server service. It is valid on map services, feature services, and image services only. Example `serviceUsername = myuser1`
servicePassword	Sets the password on a secure on-premises ArcGIS Server service. It is valid on map services, feature services, and image services only. Example `servicePassword = mypassword1`
serviceProxyFilter	A JSON object with category, sourceCountry, and searchExtent properties that is used to restrict service item response results based on a specified filter, for example, limit results returned from a geocode service based on defined filters. This is only applicable to Geocoding Service type items. The three properties can be used independently or in any combination, and they are applied as a Boolean AND operator when used in combination. category—A comma-delimited list of one or more categories from the geocoding service. sourceCountry—The 2-digit or 3-digit country code supported by the geocoding service. searchExtent—A JSON envelope object that is used to limit the geocode to a specific search area. Example `{ "sourceCountry": "USA", "searchExtent": { "xmin": -13184700, "ymin": 3988556, "xmax": -13004945, "ymax": 4061479, "spatialReference": { "wkid": 102100 } } } //or { "category" : "MGRS" }`
categories	A JSON array or comma-separated list of categories to add to the item. Example `["/Categories/Basemaps", "/Categories/Transportation"] //or /Categories/Basemaps, /Categories/Transportation`

Group parameters

The following parameters represent properties of a group that are available on the Create Group and Update Group operations:


Parameter	Details
title	The group title must be unique for the username, and the character limit is 250. Example `title=Redlands Fire Department`
description	A description of the group that can be any length. Example `description=The Redlands Fire Department is a progressive organization that leads the community in public safety. Join our group to view important maps and applications on fire safety.`
typeKeywords	Type keywords describe the type and should logically apply to all items in the group. Use this parameter only if you want to add additional type keywords. Syntax `typeKeywords=<keyword1>, <keyword2>` Example `typeKeywords=transportation`
snippet	Snippet or summary of the group that has a character limit of 250 characters. Example `snippet=Your source of visual information regarding fire safety in Redlands, California.`
tags	Tags are words or short phrases that describe the group. Separate terms with commas. Example `tags=fire, Redlands, California, public safety`
phone	The group contact information. It can be a combination of letters and numbers. The character limit is 50. Example `phone=https://www.ci.redlands.ca.us/fire/index.htm, 35 Cajon Street, Redlands, CA 92373`
access	Sets the access level for the group. private is the default. Setting to org restricts group access to members of your organization. If public, all users can access the group. Values: private \| org \| public Example `access=org`
sortField	Sets the sort field for group items. Values: title \| owner \| avgrating \| numviews \| created \| modified Example `sortField=title`
sortOrder	Sets sort order for group items. Values: asc \| desc Example `sortOrder=desc`
isViewOnly	Allows the group owner or admin to create view-only groups where members are not able to share items. If members try to share, view-only groups are returned in the notshared response property. The default is false. Values: false \| true Example `isViewOnly=true`
isInvitationOnly	If true, this group will not accept join requests. If false, this group does not require an invitation to join. Only group owners and administrators can invite users to the group. The default is false. Values: true \| false Example `isInvitationOnly=true`
thumbnail	Enter the path to the thumbnail image to be used for the group. For best results, images that are 400 pixels wide by 400 pixels high or larger with an aspect ratio of 1:1 are recommended. Supported file formats are PNG, GIF, and JPEG with a maximum file size of 10 MB. This will not be a reference to the file but the file itself that is stored on the sharing servers. Group thumbnails can be retrieved at different dimensions by specifying a URL parameter w for the desired image width: Example `https://www.arcgis.com/sharing/rest/community/groups/[groupID]/info/thumbnail.png?w=256` Supported retrievable thumbnail widths for groups are 64 pixels, 128 pixels, 150 pixels (default), and 256 pixels, with an aspect ratio of 1:1. Other specified sizes will be snapped to the next highest supported dimension for query. If the original image dimension is smaller than the size queried, the original image will be returned. Example `thumbnail=subfolder/thumbnail.jpg`
capabilities	The shared update capability. This is only available to default administrators or custom administrators with the createUpdateCapable privilege (set at creation only). updateItemControl is for a shared update control group and distributed is for a preexisting group that is part of a distributed collaboration workspace. Values: updateItemControl \| distributed Example `capabilities=updateItemControl`
leavingDisallowed	Only applies to organization accounts. If true, members are not allowed to leave this group. This is only available to default administrators. Values: true \| false Example `leavingDisallowed=true`
hiddenMembers	Only applies to organization accounts. If true, only the group owner, group managers, and default administrators can see all members of the group. Values: true \| false Example `hiddenMembers=true`
membershipAccess	Sets the membership access for the group. Setting to org restricts group access to members of your organization. Setting to collaboration restricts the membership access to partnered collaboration and your organization members. If nothing is set, any organization will have access. Values: org \| collaboration \| none Example `membershipAccess=org`
autoJoin	Only applies to organization accounts. If true, this group will allow joining without requesting membership approval. The default is false. Values: false \| true Example `autoJoin=true`

User parameters

User parameters represent the properties of a user that are available on the Update User operation.


Parameter	Details
access	Determines whether other users can search for this user by name. Setting this to private hides the user from user searches and invites. If org, only members of your organization can search for this user. Setting this to public makes the user searchable. The default is public. Values: private \| org \| public Example `access=public`
preferredView	The user can set a preferred view by using this metadata parameter. The default is Web. Values: Web \| GIS \| null Example `preferredView=GIS`
description	A description of the user. Example `description=John Smith brings over 15 years of GIS experience in software development and research to GIS Cloud Services, Inc. He received his Master of Science from the University of California, Santa Barbara, and currently resides in Redlands, CA.`
tags	Tags are words or short phrases that describe the user. Separate terms with commas. Example `tags=GIS Analyst, Redlands, cloud GIS`
thumbnail	Enter the path to the thumbnail image to be used for the user. For best results, images that are 400 pixels wide by 400 pixels high or larger with an aspect ratio of 1:1 are recommended. Supported file formats are PNG, GIF, and JPEG with a maximum file size of 10 MB. This will not be a reference to the file but the file itself that is stored on the sharing servers. User thumbnails can be retrieved at different dimensions by specifying a URL parameter w for the desired image width: Example `https://<user-url>/info/thumbnail.png?w=200` Supported retrievable thumbnail widths for users are 100 pixels, 150 pixels (default), 200 pixels, and 400 pixels, with an aspect ratio of 1:1. Other specified sizes will be snapped to the next highest supported dimension for query. If the original image dimension is smaller than the size queried, the original image will be returned. Example `thumbnail=subfolder/thumbnail.jpg`
password	Password for the user. This is only applicable for the ArcGIS identity provider. Example `password=pass1`
fullname	The full name of the user. This is only applicable for the arcgis identity provider. Example `fullname=John Smith`
email	The email address of the user. This is only applicable for the arcgis identity provider. Example `[email protected]`
securityQuestionIdx	The index of the security question the user wants to use. The security question is used for password recovery. This is only applicable for the arcgis identity provider. Example `securityQuestionIdx=1`
securityAnswer	The answer to the security question for the user. This is only applicable for the arcgis identity provider. Example `securityAnswer=myanswer`
culture	Specifies the locale for which content is returned. The browser or machine language setting is the default. Authenticated users can set the culture and overwrite the browser or machine language setting. Example `culture=fr`
cultureFormat	Specifies the user-preferred number and date format according to CLDR. This is only applicable for English and Spanish; in other words, culture is en or es. See Languages for supported formats; it will inherit from organization cultureFormat if undefined.
region	Specifies the region of featured maps and apps and the basemap gallery. Example `region=FR`
idpUsername	The identity provider username if using enterprise logins. Example `[email protected]`

Portal parameters

The following parameters represent the properties of a portal:


Parameter	Details
name	The name of the organization or portal. The character limit is 250. Example `name=City of Cloud Creek`
access	Determines who can view your organization as an anonymous user. Setting to public allows anonymous users to access your organization's custom URL. Setting to private restricts access to only members of your organization. The default is public. Values: private \| public Example `access=private`
description	A description of the organization or portal. It can be of any length. Example `description=City of Cloud Creek was founded in 1851 and is located on the banks of Cloud Creek, 60 miles Northwest of Portland, Oregon. Cloud Creek prides itself on its historic charm and stunning natural setting. Since 1987, GIS technology has become an integral part of almost all of Cloud Creek's governmental functions. As the next step in the GIS evolution, Cloud Creek has an initiative to put all GIS maps online.`
canSharePublic	Allows members of the organization to share outside the organization. The default is true. Values: true \| false Example `canSharePublic=false`
canSearchPublic	Allows members of the organization to search outside the organization. The default is true. Values: true \| false Example `canSearchPublic=false`
thumbnail	Enter the key Add Resource containing the thumbnail. Acceptable image formats are PNG, GIF, and JPEG. Example `thumbnail=logo.png`
urlKey	The prefix that will be used in the URL for this portal, for example, <urlkey>.maps.arcgis.com.
urlHostname	A custom URL for this portal. Example `urlHostname=mySite`
culture	The default locale (language and country) information. The format for the culture code is based on a language code and a country code separated by a dash: The language code is based on the two-letter codes found at the Library of Congress Codes for the Representation of Names of Languages page. The country code is based on the two-letter codes found by searching the ISO Online Browsing Platform. Example `culture=en–US`
cultureFormat	The preferred number and date format defined according to CLDR (only applicable to English and Spanish, in other words, when culture is en or es). See Languages for supported formats. Example `cultureFormat=us`
featuredItemsGroupQuery	The query that identifies the group containing featured items for the gallery. Set a Group ID or, if null, the most viewed items in your organization are displayed in the gallery.
region	The region of the organization.
portalProperties	Stores properties specific to the organization, for example, the contact us link. If the organization is public, the properties are visible to anonymous users.
units	Sets the units of measure for the organization users. The user default is derived from the organization's region. Set units to english for U.S. standards or metric.
homePageFeaturedContentCount	The number of featured items that can be displayed on the home page up to a maximum of 100, in tntegers only.
homePageFeaturedContent	The group that contains featured content to be displayed on the organization home page.
basemapGalleryGroupQuery	The query that identifies the group containing the web maps that display in the basemap gallery for Map Viewer.
devbasemapGalleryGroupQuery	The query that identifies the group containing the web maps that display in the basemap gallery for Map Viewer for developer subscriptions.
templatesGroupQuery	The query that identifies the template group used in the configurable apps gallery.
layerTemplatesGroupQuery	The query that identifies the group containing editing templates used in Map Viewer.
symbolSetsGroupQuery	The query that identifies the symbol set group for rendering in Map Viewer.
colorSetsGroupQuery	The query that identifies the group containing the color sets used for rendering in Map Viewer.
analysisLayersGroupQuery	The query that identifies the group containing the layers shown in the Analysis Layers gallery for the analysis tools.
featuredGroups	The featured groups for the organization highlighted on the Groups page.
defaultBasemap	The default basemap displayed in Map Viewer.
defaultExtent	The default extent of the organization, used when users create a web map. Example `{ "type": "extent", "xmin": -14999999.999998225, "ymin": 2699999.9999996624, "xmax": -6199999.999999268, "ymax": 6499999.999998959, "spatialReference": { "wkid": 102100 } }`
rotatorPanels	Custom HTML for the organization home page.
showHomePageDescription	If true, the description of the organization displays on the home page.
backgroundImage	The background image that displays behind all other components on the home page. Accept the default background image, specify a URL for a custom background image, or specify that no background image displays.
geocodeService	An array of ArcGIS geocode services to use for geosearch and batch geocoding. Example `[ { "url": "https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer", "northLat": "Ymax", "southLat": "Ymin", "eastLon": "Xmax", "westLon": "Xmin", "name": "Esri World Geocoder", "batch": true, "placefinding": true, "suggest": true }, { "singleLineFieldName": "SingleLine", "url": "https://sampleserver.domain.com/arcgis/rest/services/Locators/serviceName/GeocodeServer", "name": "Locator Name", "placeholder": "", "placefinding": true, "batch": true, "zoomScale": 10000 } ]`
routeServiceLayer	ArcGIS NASever service for synchronous route analysis. Example `{ "url": "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World", "defaultTravelMode": "FEgifRtFndKNcABC", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
geometryService	ArcGIS GeometryServer to use for geometry functions. Example `{ "url": "https://utility.arcgisonline.com/arcgis/rest/services/Geometry/GeometryServer" }`
elevation3DService	Limited Error Raster Compression (LERC) elevation service used by ArcGIS Pro and Web Scene Viewer. Example `[ { "url": "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer", "id": "globalElevation", "layerType": "ArcGISTiledElevationServiceLayer" } ]`
printServiceTask	ArcGIS PrintServer task to use for printing functionality. Example `{ "url": "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task" }`
closestFacilityService	ArcGIS NAServer service for synchronous closest-facility analysis. Example `{ "url": "https://route.arcgis.com/arcgis/rest/services/World/ClosestFacility/NAServer/ClosestFacility_World", "defaultTravelMode": "FEgifRtFndKNcABC", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
asyncClosestFacilityService	ArcGIS geoprocessing service for asynchronous closest-facility analysis. Example `{ "url": "https://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities", "defaultTravelMode": "FEgifRtFndKNcABC", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
serviceAreaService	ArcGIS NAServer service for synchronous service-area analysis. Example `{ "url": "https://route.arcgis.com/arcgis/rest/services/World/ServiceAreas/NAServer/ServiceArea_World", "defaultTravelMode": "FEgifRtFndKNcABC", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
asyncServiceAreaService	ArcGIS geoprocessing service for asynchronous service-area analysis. Example `{ "url": "https://logistics.arcgis.com/arcgis/rest/services/World/ServiceAreas/GPServer/GenerateServiceAreas", "defaultTravelMode": "FEgifRtFndKNcABC", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
odCostMatrixService	ArcGIS network service for synchronous origin-destination cost matrix analysis. This was introduced at 10.8.1. Example `{ "url": " https://route.arcgis.com/arcgis/rest/services/World/OriginDestinationCostMatrix/NAServer/OriginDestinationCostMatrix_World", "defaultTravelMode": "FEgifRtFndKNcABC", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
asyncODCostMatrixService	ArcGIS geoprocessing service for generating origin-destination cost matrices asynchronously. Example `{ "url": "https://logistics.arcgis.com/arcgis/rest/services/World/Route/GPServer", "defaultTravelMode": "FEgifRtFndKNcABC", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
syncVRPService	ArcGIS geoprocessing service for solving synchronous vehicle routing problems. Example `{ "url": "https://logistics.arcgis.com/arcgis/rest/services/World/VehicleRoutingProblemSync/GPServer/EditVehicleRoutingProblem", "defaultTravelMode": "FEgifRtFndKNcABC", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
asyncVRPService	ArcGIS geoprocessing service for solving asynchronous vehicle routing problems. Example `{ "url": "https://logistics.arcgis.com/arcgis/rest/services/World/VehicleRoutingProblemSync/GPServer/EditVehicleRoutingProblem", "defaultTravelMode": "FEgifRtFndKNcABC", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
geoenrichmentService	ArcGIS GeoenrichmentServer. Example `{ "url": "https://geoenrich.arcgis.com/arcgis/rest/services/World/GeoenrichmentServer" }`
analysisService	Hosted geoprocessing services that perform analyses.
routingServicesSource	The routing services' source and configuration information. This was introduced at 11.0. Examples `//When configured with ArcGIS Online routingServicesSource={ "sourceName": "ArcGISOnline", "agoUsername": "agoExampleAdmin", "firstName": "Example", "lastName": "Admin" } //When configured with services from ArcGIS Server site that is not federated with you ArcGIS Enterprise organization "routingServicesSource"={ "sourceName": "Custom" }`
trafficService	ArcGIS map service for displaying traffic speeds and traffic incidents. Example `{ "url": "https://traffic.arcgis.com/arcgis/rest/services/World/Traffic/MapServer", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
trafficDataService	Introduced at 10.8.1. ArcGIS geoprocessing service that can be used to configure live traffic with ArcGIS StreetMap Premium network datasets. Example `{ "url": https://traffic.arcgis.com/arcgis/rest/services/World/TrafficFeeds/GPServer, "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
asyncRouteService	ArcGIS geoprocessing service for asynchronous route analysis. Example `{ "url": "https://logistics.arcgis.com/arcgis/rest/services/World/Route/GPServer", "defaultTravelMode": "FEgifRtFndKNcABC", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
asyncLocationAllocationService	ArcGIS geoprocessing service for asynchronous location-allocation network analysis. Example `{ "url": "https://logistics.arcgis.com/arcgis/rest/services/World/LocationAllocation/GPServer", "defaultTravelMode": "FEgifRtFndKNcABC", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
routingUtilitiesService	ArcGIS geoprocessing service that provides auxiliary information, such as travel modes, used by the routing services. Example `{ "url": "https://logistics.arcgis.com/arcgis/rest/services/World/Utilities/GPServer", "itemId": "1f49a1890b3d4d9c91ecd341c83e7228" }`
elevationService	ArcGIS geoprocessing service for elevation analysis. Example `{ "url": "https://elevation.arcgis.com/arcgis/rest/services/Tools/Elevation/GPServer" }`
elevationSyncService	ArcGIS geoprocessing service for synchronous elevation analysis. Example `{ "url": "https://elevation.arcgis.com/arcgis/rest/services/Tools/ElevationSync/GPServer" }`
hydrologyService	ArcGIS geoprocessing service for hydrological analysis. Example `{ "url": "https://hydro.arcgis.com/arcgis/rest/services/Tools/Hydrology/GPServer" }`
asyncGeocode	ArcGIS geoprocessing service for performing batch geocoding asynchronously. Example `{ "url": "https://analysis1.arcgis.com/arcgis/rest/services/tasks/GPServer" }`
orthomappingElevationService	ArcGIS image service used by Ortho Maker. Example `{ "url": "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer" }`
rasterUtilitiesService	ArcGIS geoprocessing service that enables raster analysis and processing. Example `{ "url": "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/RasterUtilities/GPServer" }`
bingKey	The Bing key to use for web maps using Bing Maps.
canShareBingPublic	The Bing key can be shared to the public and is returned as part of the portal's call (/sharing/rest/portals/<orgid>). This requires the access property of the portal to be set as public. The canShareBingPublic property is not returned publicly but only shown to the users within the organization.
authorizedCrossOriginDomains	An array of trusted servers that clients can send credentials to when making Cross-Origin Resource Sharing (CORS) requests to access web-tier secured services.
allowedOrigins	An array of up to 100 web application domains to restrict CORS access to the Portal Directory API.
allowedRedirectUris	A JSON array of allowed redirect URIs that represent portal instances that you share secure content with. This will allow your organization users to be able to use enterprise logins to access the secured content through web applications hosted on these portals.
allSSL	Indicates whether the organization uses HTTPS. If true, all calls made against resources that belong to the organization will require HTTPS. The default is false. Values: true \| false
useStandardizedQuery	If true, only simple WHERE clauses that are compliant with SQL92 can be used when querying layers and tables. The recommended security setting is true. Values: true \| false
canSigninArcGIS	Allows an organization with an enterprise IDP configured to be able to turn on or off the ArcGIS sign in. The default is true. Values: true \| false
canSigninIDP	Allows an organization with an enterprise IDP configured to be able to turn on or off the enterprise sign in. The default is true. Values: true \| false
commentsEnabled	Allows the organization to disable commenting. The default is true. When commentsEnabled is false, comments are hidden and not removed. numComments is set to zero for all items in the organization. Calls to add a comment and view comments will fail. If the organization reenables comments, the comments display and numComments is restored. Values: true \| false
maxTokenExpirationMinutes	The maximum validity in minutes of tokens issued for users of the organization: -1 is the default and is a special value that indicates infinite timeout or permanent tokens. For tokens granted using an OAuth2 authorization grant, it represents the maximum validity of refresh tokens. For access tokens, the maximum validity is the lower of two weeks or this value.
mfaEnabled	Indicates whether organization members are allowed to choose to set up multifactor authentication for their individual accounts.
mfaAdmins	An array of at least two designated administrators who receive requests to troubleshoot members' multifactor authentication issues.
metadataEditable	Indicates whether the organization has metadata enabled. Values: true \| false
creditAssignments	Indicates whether the organization has credit budgeting enabled. The default is disabled. Values: enabled \| disabled
defaultUserCreditAssignment	Default allocation of credits for new members. -1 for no allocated limit. Example `defaultUserCreditAssignment=500`
updateUserProfileDisabled	Indicates whether organization members are allowed to edit their biographical information and who can see their profiles. Values: true \| false
useVectorBasemaps	If true, the organization uses the Esri vector basemaps in supported ArcGIS apps and basemapGalleryGroupQuery will not be editable and will be set to the default query.
metadataFormats	Metadata style used for organization. Example `metadataFormats= iso19139-3.2`
clearEmptyFields	Clears any string fields that are passed in empty, such as a description. Example `clearEmptyFields=true`
contacts	An array of chosen administrators listed as points of contact whose email addresses will be listed as points of contact in the automatic email notifications sent to organization members when they request password resets, help with their usernames, modifications to their accounts, or any issues related to the allocation of credits to their accounts. Example `contacts= ["admin1","admin2","admin3"]`

Paging parameters

The following parameters represent the properties of contents that are available on the User Content, Item Comments, and Group Content resources:


Parameter	Details
start	The number of the first entry in the result set response. The index number is 1-based. The default value of start is 1. Example `start=11`
num	The maximum number of results to be included in the result set response. The default value is 10, and the maximum allowed value is 100. Note that the actual number of returned results may be less than num. This happens when the number of results remaining after start is less than num. Example `//Returns a max of 50 results in the response num=50`

Paging properties

A JSON object specified for pagination. Its syntax and properties are as follows:

JSON syntax

Paging properties


{
  "total": <int>,
  "start": <int>,
  "num": <int>,
  "nextStart": <int>
}


Property	Details
total	The total number of results found for the whole query.
start	The number of the first entry in the result set for this response. The index number is 1-based.
num	The number of results included in the result set for this response.
nextStart	The next entry index if the current result set doesn't contain all results, or -1 if it is the last batch.

Listing properties

A listing is specified as a JSON object. Its syntax and properties are as follows:

JSON syntax

              
            

{
  "licenseType": "<free | ela | consumption | preprovisioned>",
  "listingAccess": "<private | public>",
  "priceDesc": "<priceDesc>",
  "creditsPerTransaction": <creditsPerTransaction>,
  "trialSupported": <true | false>,
  "trialDuration": <trialDuration>,
  "ecommerceEnabled": <true | false>,
  "licenseBy": <licenseByOrg | licenseByUser>
}


Property	Details
licenseType	The type of license offered by the listing. The free value specifies whether the listing will be provisioned to the customer for free. The ela value specifies whether an enterprise license agreement needs to be agreed on between the vendor and the customer. The consumption value specifies a consumption-based model, which typically applies to data services. The preprovisioned value specifies whether the item is preprovisioned and ready to use. Values: free \| ela \| consumption \| preprovisioned
listingAccess	Indicates whether the listing is public or private. Values: public \| private
priceDesc	Text that describes the pricing details of this listing. This property is not required for free listings.
creditsPerTransaction	The number of credits that will be charged to the customer per transaction. This property only applies to consumption-based listings.
trialSupported	Indicates whether or not the listing supports trials. Values: true \| false
trialDuration	Duration of the trial in days. Applies only when trialSupported is true.
ecommerceEnabled	Indicates whether or not the listing is e-commerce enabled. Values: true \| false
licenseBy	Listing licensing model. The default is licenseByOrg if this property is missing. Values: licenseByUser \| licenseByOrg

Provision properties

Marketplace items are provisioned to customers. A provision is specified as a JSON object. Its syntax and properties are described as follows:

JSON syntax

              
            

{
  "itemId": "<itemId>",
  "orgId": "<vendorOrgId>",
  "purchaserOrgId": "<purchaserOrgId>",
  "purchaserUsername": "<purchaserUsername>",
  "purchaserFullName": <purchaserFullName>,
  "purchaserEmail": <purchaserEmail>,
  "purchaserPhone": <purchaserPhone>,
  "startDate": <provisionStartDate>,
  "endDate": <provisionEndDate>, // -1 indicates an unexpiring provision
  "purchased": <true | false>,
  "trial": <true | false>,
  "interested": <true | false>,
  "created": <createdDate>,
  "modified": <modifiedDate>,
  "orgEntitlements": {
    "maxUsers": <maximum number of users>,
    "entitlementsModified": <epoch timestamp when org entitlements were last modified>,
    "entitlements": {
        "<entitlement string>": {"num": <number of users>} //entitlement string uniquely identifies entitlement, listing itemId is used typically 
    }
  }
}


Property	Details
itemId	ID of the provisioned item.
orgId	Organization ID of the vendor organization.
purchaserOrgId	Organization ID of the purchasing organization.
purchaserUsername	Username of the purchaser.
purchaserFullName	Full name of the purchaser.
purchaserEmail	Email address of the purchaser.
purchaserPhone	Phone number of the purchaser.
startDate	The date and time (in milliseconds from epoch) when this provision was started.
endDate	Date and time (in milliseconds from epoch) when this provision ends or expires. A value of -1 indicates an unexpiring provision.
purchased	Boolean value. This value is true if the item was purchased.
trial	Boolean value. This value is true if the item is being tried by the purchasing organization.
interested	Boolean value. This value is true if the purchasing organization has expressed interest in the item.
created	Date and time (in milliseconds from epoch) when this provision was created.
modified	Date and time (in milliseconds from epoch) when this provision was last modified.
orgEntitlements	The set of entitlements available to the purchasing organization for license-by-user listings only.

Purchaser parameters

Purchaser parameters are specified when provisioning a marketplace listing.


Parameter	Details
purchaserFullName	Full name of the purchaser.
purchaserEmail	Email address of the purchaser.
purchaserPhone	Phone number of the purchaser.

Allowable HTML tags

The following table lists the allowable HTML tags that can be used in descriptive parameters, such as the description of an item. All other tags will be filtered out.


Tag	Attribute
a	href, target, style
img	src, width, height, border, alt, style
span	style
table	width, height, cellpadding, cellspacing, border, style
div	align, style
font	size, color, style, face
tr	height, valign, align, style
td, th	height, width, valign, align, colspan, rowspan, valign, nowrap, style
p	align, style
source	media, src, type
audio, video	controls, width, height, autoplay, loop, muted, preload, poster
b, u, strong, i, em, br, li, ul, ol, tbody, hr	Not applicable

Allowed protocols for href and src are https and mailto.
Tags will be automatically closed if not closed.

Note:

The <, >, &, and ' symbols will be escaped outside of allowed tags if not otherwise escaped using either &lt, &gt. &amp. &quot.

Date format

UNIX time is defined as the number of seconds that have elapsed since midnight on January 1, 1970.

Feedback on this topic?

Parameters common to all operations

Item parameters

Note:

Note:

Group parameters

User parameters

Portal parameters

Paging parameters

Paging properties

JSON syntax

Listing properties

JSON syntax

Provision properties

JSON syntax

Purchaser parameters

Allowable HTML tags

Note:

Date format

In this topic