Common parameters
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 to access authenticated resource. Generated by thegenerateToken call, an access token that identifies the authenticated user and controls access to restricted Example |
| The output format can be HTML, JSON, or PJSON. The default is HTML.Search anditem comments support RSS as an output format. Values: |
| Callback is used for JavaScript clients that need a response. Example Response |
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 |
|---|---|
| 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 |
| 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 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 |
| 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 |
| The file that stores the metadata information on an item. It's stored in the metadata folder under esriinfo, for example, Example |
| Indicates if the administrator enabled editing metadata on the item pages, for the organization. If Values: |
| Metadata style used for organization. Default is Values: |
(Required) | The type of the item. Must be drawn from the list of supported types. SeeItems and item types for a list of the supported types. The parameter is not applicable to the Example |
| Type keywords describe the type and should logically apply to all items of that type. SeeItems 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. Syntax Example |
| An item description less than 64 Kb. Example |
| Tags are words or short phrases that describe the specific item. Separate with commas. Syntax Example |
| Snippet or summary for the item. Limit this brief descriptive text to 2048 characters. Example |
| The bounding rectangle of the item. Syntax Example |
| The coordinate system of the item. Example 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. |
| Credits the source of the item. Example |
| Includes any license information or restrictions. Example |
| The item locale (language and country) information. When adding a new item, the following apply:
When updating an item, the following apply:
The format for a culture code is based on a language code and a country code separated by a dash:
|
| 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. |
| An array that primarily applies to a list of categories that the application item is applicable to. |
| An array that primarily applies to industries associated with the application. |
| An array that primarily applies to languages associated with the application. |
| Primarily applies to the thumbnail associated with an application. This is the URL to the thumbnail used for the application. |
| Primarily applies to the banner associated with an application. This is the URL to the banner used for the application. |
| An array that primarily applies to screenshots associated with an application. This is the URL to the screenshots used for the application. |
| A JSON object consists of listing properties when the item is listed in ArcGIS Marketplace. For detailed syntax and properties, seeListing properties. |
| Sets the username on a secure on-premises ArcGIS Server service. It is valid on map services, feature services, and image services only. Example |
| Sets the password on a secure on-premises ArcGIS Server service. It is valid on map services, feature services, and image services only. Example |
| A JSON object with This is only applicable to
Example |
| A JSON array or comma-separated list of categories to add to the item. Example |
Group parameters
The following parameters represent properties of a group that are available on the Create Group and Update Group operations:
| Parameter | Details |
|---|---|
| The group title must be unique for the username, and the character limit is 250. Example |
| A description of the group that can be any length. Example |
| 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 Example |
| Snippet or summary of the group that has a character limit of 250 characters. Example |
| Tags are words or short phrases that describe the group. Separate terms with commas. Example |
| The group contact information. It can be a combination of letters and numbers. The character limit is 50. Example |
| Sets the access level for the group. Values: |
| Sets the sort field for group items. Values: |
| Sets sort order for group items. Values: |
| 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 Values: |
| If Values: |
| 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 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 |
| The shared update capability. This is only available to default administrators or custom administrators with the
Values: |
| Only applies to organization accounts. If Values: |
| Only applies to organization accounts. The default is Only the default administrators can change this setting to Values: This applies only to ArcGIS Online organizations. |
| Sets the membership access for the group. Setting to Values: |
| Only applies to organization accounts. If |
User parameters
User parameters represent the properties of a user that are available on the Update User operation.
| Parameter | Details |
|---|---|
| Determines whether other users can search for this user by name. Setting this to Values: |
| The user can set a preferred view by using this metadata parameter. The default is Values: |
| A description of the user. Example |
| Tags are words or short phrases that describe the user. Separate terms with commas. Example |
| 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 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 |
| Password for the user. This is only applicable for the ArcGIS identity provider. Example |
| The full name of the user. This is only applicable for the arcgis identity provider. Example |
| The email address of the user. This is only applicable for the arcgis identity provider. Example |
| 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 |
| The answer to the security question for the user. This is only applicable for the arcgis identity provider. Example |
| 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 |
| Specifies the user-preferred number and date format according to CLDR. This is only applicable for English and Spanish; in other words, |
| Specifies the region of featured maps and apps and the basemap gallery. Example |
| The identity provider username if using enterprise logins. Example |
Portal parameters
The following parameters represent the properties of a portal:
| Parameter | Details |
|---|---|
| The name of the organization or portal. The character limit is 250. Example |
| Determines who can view your organization as an anonymous user. Setting to Values: |
| A description of the organization or portal. It can be of any length. Example |
| Allows members of the organization to share outside the organization. The default is Values: |
| Allows members of the organization to search outside the organization. The default is Values: |
| Enter the Example |
| The prefix that will be used in the URL for this portal, for example, |
| A custom URL for this portal. Example |
| 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:
Example |
| The preferred number and date format defined according to CLDR (only applicable to English and Spanish, in other words, when SeeLanguages for supported formats. Example |
| 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. |
| The region of the organization. |
| Stores properties specific to the organization, for example, the contact us link. If the organization is public, the properties are visible to anonymous users. |
| Sets the units of measure for the organization users. The user default is derived from the organization's region. Set units to |
| The number of featured items that can be displayed on the home page up to a maximum of 100, in tntegers only. |
| The group that contains featured content to be displayed on the organization home page. |
| The query that identifies the group containing the web maps that display in the basemap gallery for Map Viewer. |
| The query that identifies the group containing the web maps that display in the basemap gallery for Map Viewer for developer subscriptions. |
| The query that identifies the template group used in the configurable apps gallery. |
| The query that identifies the group containing editing templates used in Map Viewer. |
| The query that identifies the symbol set group for rendering in Map Viewer. |
| The query that identifies the group containing the color sets used for rendering in Map Viewer. |
| The query that identifies the group containing the layers shown in the Analysis Layers gallery for the analysis tools. |
| The featured groups for the organization highlighted on the Groups page. |
| The default basemap displayed in Map Viewer. |
| The default extent of the organization, used when users create a web map. Example |
| Custom HTML for the organization home page. |
| If Values: |
| 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. |
| An array of ArcGIS geocode services to use for geosearch and batch geocoding. Example |
| ArcGIS Example |
| ArcGIS Example |
| Limited Error Raster Compression (LERC) elevation service used by ArcGIS Pro and Web Scene Viewer. Example |
| ArcGIS Example |
| ArcGIS Example |
| ArcGIS geoprocessing service for asynchronous closest-facility analysis. Example |
| ArcGIS Example |
| ArcGIS geoprocessing service for asynchronous service-area analysis. Example |
| ArcGIS network service for synchronous origin-destination cost matrix analysis. This was introduced at 10.8.1. Example |
| ArcGIS geoprocessing service for generating origin-destination cost matrices asynchronously. Example |
| ArcGIS geoprocessing service for solving synchronous vehicle routing problems. Example |
| ArcGIS geoprocessing service for solving asynchronous vehicle routing problems. Example |
| Introduced at ArcGIS Enterprise 11.3 and in ArcGIS Online's February 2024 release. ArcGIS geoprocessing service for solving asynchronous fleet routing problems. This property replaces the Example |
| ArcGIS Example |
| Hosted geoprocessing services that perform analyses. |
| The routing services' source and configuration information. This was introduced at 11.0. Examples |
| ArcGIS map service for displaying traffic speeds and traffic incidents. Example |
| Introduced at 10.8.1. ArcGIS geoprocessing service that can be used to configure live traffic with ArcGIS StreetMap Premium network datasets. Example |
| ArcGIS geoprocessing service for asynchronous route analysis. Example |
| ArcGIS geoprocessing service for asynchronous location-allocation network analysis. Example |
| ArcGIS geoprocessing service that provides auxiliary information, such as travel modes, used by the routing services. Example |
| ArcGIS geoprocessing service for elevation analysis. Example |
| ArcGIS geoprocessing service for synchronous elevation analysis. Example |
| ArcGIS geoprocessing service for hydrological analysis. Example |
| ArcGIS geoprocessing service for performing batch geocoding asynchronously. Example |
| ArcGIS image service used by Ortho Maker. Example |
| ArcGIS geoprocessing service that enables raster analysis and processing. Example |
| Introduced at ArcGIS Enterprise 11.4. ArcGIS synchronous service to snap a series of GPS track points to the underlying roads. Example |
| The Bing key to use for web maps using Bing Maps. |
| The Bing key can be shared to the public and is returned as part of the portal's call ( |
| 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. |
| An array of up to 100 web application domains to restrict CORS access to the Portal Directory API. |
| 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. |
| Indicates whether the organization uses HTTPS. If Values: |
| If Values: |
| Allows an organization with an enterprise IDP configured to be able to turn on or off the ArcGIS sign in. The default is Values: |
| Allows an organization with an enterprise IDP configured to be able to turn on or off the enterprise sign in. The default is Values: |
| Allows the organization to disable commenting. The default is Values: |
| 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. |
| Indicates whether organization members are allowed to choose to set up multifactor authentication for their individual accounts. |
| An array of at least two designated administrators who receive requests to troubleshoot members' multifactor authentication issues. |
| Indicates whether the organization has metadata enabled. Values: |
| Indicates whether the organization has credit budgeting enabled. The default is Values: |
| Default allocation of credits for new members. Example |
| Indicates whether organization members are allowed to edit their biographical information and who can see their profiles. Values: |
| If Values: |
| Metadata style used for organization. Example |
| Clears any string fields that are passed in empty, such as a description. Values: |
| 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 |
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 |
|---|---|
| The number of the first entry in the result set response. The index number is 1-based. The default value of Example |
| The maximum number of results to be included in the result set response. The default value is Example |
Paging properties
A JSON object specified for pagination. Its syntax and properties are as follows:
JSON syntax
Paging properties
123456{ "total":<int>, "start":<int>, "num":<int>, "nextStart":<int>}| Property | Details |
|---|---|
| The total number of results found for the whole query. |
| The number of the first entry in the result set for this response. The index number is 1-based. |
| The number of results included in the result set for this response. |
| 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
12345678910{ "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 |
|---|---|
| The type of license offered by the listing. The Values: |
| Indicates whether the listing is Values: |
| Text that describes the pricing details of this listing. This property is not required for free listings. |
| The number of credits that will be charged to the customer per transaction. This property only applies to consumption-based listings. |
| Indicates whether or not the listing supports trials. Values: |
| Duration of the trial in days. Applies only when |
| Indicates whether or not the listing is e-commerce enabled. Values: |
| Listing licensing model. The default is Values: |
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
1234567891011121314151617181920212223{ "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 |
|---|---|
| ID of the provisioned item. |
| Organization ID of the vendor organization. |
| Organization ID of the purchasing organization. |
| Username of the purchaser. |
| Full name of the purchaser. |
| Email address of the purchaser. |
| Phone number of the purchaser. |
| The date and time (in milliseconds from epoch) when this provision was started. |
| Date and time (in milliseconds from epoch) when this provision ends or expires. A value of -1 indicates an unexpiring provision. |
| Boolean value. This value is |
| Boolean value. This value is |
| Boolean value. This value is |
| Date and time (in milliseconds from epoch) when this provision was created. |
| Date and time (in milliseconds from epoch) when this provision was last modified. |
| 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 |
|---|---|
| Full name of the purchaser. |
| Email address of the purchaser. |
| 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 |
|---|---|
| href, target, style |
| src, width, height, border, alt, style |
| style |
| width, height, cellpadding, cellspacing, border, style |
| align, style |
| size, color, style, face |
| height, valign, align, style |
| height, width, valign, align, colspan, rowspan, valign, nowrap, style |
| align, style |
| media, src, type |
| controls, width, height, autoplay, loop, muted, preload, poster |
| Not applicable |
- Allowed protocols for href and src are https and mailto.
- Tags will be automatically closed if not closed.
The< ,> ,& , and' symbols will be escaped outside of allowed tags if not otherwise escaped using either<,>,&,".
Date format
UNIX time is defined as the number of seconds that have elapsed since midnight on January 1, 1970.