Types of portal settings

In ArcGIS, a self request to the portal allows you to access organizational settings through the ArcGIS Portal Directory. This allows administrators to learn various capabilities of the portal. To make a self-call using the portal service, you need to send a request to the ArcGIS REST API endpoint.

Example

This example shows how to execute a self request using the portal service.

Request

HTTPHTTPcURL
Use dark colors for code blocksCopy
POST arcgis.com/sharing/rest/portals/self HTTP/1.1
Content-Type: application/x-www-form-urlencoded

&f=json
&token=<ACCESS_TOKEN>

Response

Use dark colors for code blocksCopy
{
  "2DStylesGroupQuery": "title:\"Esri 2D Styles\" AND owner:esri_en",
  "3DBasemapGalleryGroupQuery": "title:\"ArcGIS Online 3D Basemaps\" AND owner:esri_en",
  "access": "public",
  "allSSL": true,
  "allowedRedirectUris": [],
  "analysisLayersGroupQuery": "title:\"Living Atlas Analysis Layers\" AND owner:esri",
  "authorizedCrossOriginDomains": [],
  "availableCredits": 5.0018196E7,
Expand

Example portal settings

Listed are some of the important portal settings and description.

Credits

Credits are the currency used for specific transactions and types of storage in your organization. They are consumed for activities like storing features, performing analytics, and using premium content. Most actions do not require credits, such as using basemaps, exporting data, or performing basic searches. Credits do not apply to ArcGIS Enterprise or ArcGIS Location Platform.

Expand
Use dark colors for code blocksCopy
  "analysisLayersGroupQuery": "title:\"Living Atlas Analysis Layers\" AND owner:esri",
  "authorizedCrossOriginDomains": [],
  "availableCredits": 5.0018196E7,
  "basemapGalleryGroupQuery": "title:\"United States Basemaps\" AND owner:Esri_cy_US",
  "canListApps": false,
  "canListConsultingServices": false,
Expand

Basemaps

Basemaps serve as foundational maps that provide data layers and visualizing geospatial information. They are authoritative maps curated by Esri, updated regularly with new data, and can be customized or created to suit specific mapping needs.

Property	Description
`baseMapLayers`	An array of basemap layers available in the portal.

Expand
Use dark colors for code blocksCopy
  "defaultBasemap": {
      "baseMapLayers": [
          {
              "url": "https://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer",
              "layerType": "ArcGISTiledMapServiceLayer",
              "resourceInfo": {
                  "currentVersion": 10.3,
                  "mapName": "Layers",
                  "supportsDynamicLayers": false,
                  "layers": [
                      {
                          "id": 0,
                          "name": "Citations",
                          "parentLayerId": -1,
                          "defaultVisibility": false,
                          "subLayerIds": null,
                          "minScale": 0,
                          "maxScale": 0
                      }
                  ],
Expand

Layers

A layer is a collection of geographic data used to create maps, scenes, and conduct geospatial analysis. It is used to visualize spatial information and can include various types of data such as features, imagery, and elevation.

Property	Description
`id`	The layer id, as a numeric value.
`name`	The name of the layer.
`parentLayerId`	If working with nested layers, this is the numeric value indicating the layer id of the next layer (parent) directly above the current referenced layer.
`defaultVisibility`	Default visibility of the layers in the map service.
`subLayerIds`	Integer value indicating the layer id.
`minScale`	A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator.
`maxScale`	A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator.
`url`	A URL to a service that should be used for all queries against the layer.

Expand
Use dark colors for code blocksCopy
  "defaultBasemap": {
      "baseMapLayers": [
          {
              "url": "https://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer",
              "layerType": "ArcGISTiledMapServiceLayer",
              "resourceInfo": {
                  "currentVersion": 10.3,
                  "mapName": "Layers",
                  "supportsDynamicLayers": false,
                  "layers": [
                      {
                          "id": 0,
                          "name": "Citations",
                          "parentLayerId": -1,
                          "defaultVisibility": false,
                          "subLayerIds": null,
                          "minScale": 0,
                          "maxScale": 0
                      }
                  ],
Expand

Levels of detail (LODs)

Levels of detail (LOD) are specific scales or resolutions within a TileLayer or ArcGISTiledMapServiceLayer. These LODs define the scale and resolution of each level, providing a structured way to manage and display geographic data.

Property	Description
`level`	ID for each level.
`levelValue`	String to be used when constructing URL to access a tile from this LOD.
`resolution`	Resolution in map units of each pixel in a tile for each level.
`scale`	Scale for each level.

Expand
Use dark colors for code blocksCopy
                      "lods": [
                          {
                              "level": 0,
                              "resolution": 156543.03392800014,
                              "scale": 5.91657527591555E8
                          },
                          {
                              "level": 1,
                              "resolution": 78271.51696399994,
                              "scale": 2.95828763795777E8
                          },
Expand

Extents

The initialExtent defines the bounding geometry of the basemap when it is first loaded. The fullExtent defines the complete geographic area covered by the data in a map.

Property	Description
`spatialReference`	Specifies the spatial reference of the given geometry.
`xmax`	A numeric value indicating the top-right X-coordinate of an extent envelope.
`xmin`	A numeric value indicating the bottom-left X-coordinate of an extent envelope.
`ymax`	A numeric value indicating the top-right Y-coordinate of an extent envelope.
`ymin`	A numeric value indicating the bottom-left Y-coordinate of an extent envelope.

Expand
Use dark colors for code blocksCopy
                  "initialExtent": {
                      "xmin": -2.8848255049479112E7,
                      "ymin": -2077452.082122866,
                      "xmax": 2.8848255049479112E7,
                      "ymax": 1.6430757376790084E7,
                      "spatialReference": {
                          "wkid": 102100,
                          "latestWkid": 3857
                      }
                  },
                  "fullExtent": {
                      "xmin": -2.0037507067161843E7,
                      "ymin": -1.9971868880408604E7,
                      "xmax": 2.0037507067161843E7,
                      "ymax": 1.997186888040863E7,
                      "spatialReference": {
                          "wkid": 102100,
                          "latestWkid": 3857
                      }
                  },
Expand

Supported capabilities

The terms Map, TileMap, Query, and Data refer to the supported operations or capabilities of the basemap layer. These capabilities determine how you can interact with and utilize the basemap layer in your web maps and applications16.

Operation	Description
`Map`	Allows you to display the basemap as a traditional map service layer.
`TileMap`	Enables viewing the basemap as pre-rendered tiles for better performance.
`Query`	Provides the ability to query and retrieve information about features in the basemap layer.
`Data`	Allows access to the vector data that makes up the basemap for downloading or analysis.

Expand
Use dark colors for code blocksCopy
                  "units": "esriMeters",
                  "supportedImageFormatTypes": "PNG32,PNG24,PNG,JPG,DIB,TIFF,EMF,PS,PDF,GIF,SVG,SVGZ,BMP",
                  "capabilities": "Map,Tilemap,Query,Data",
                  "supportedQueryFormats": "JSON, AMF",
Expand

Helper services

Helper services are additional services available in an organization. These services enhance mapping capabilities by providing features like address location search and demographic information. These premium helper services include functionalities like:

Feature analysis
Elevation analysis
Raster analysis
Geoenrichment
Printing
Routing

Expand
Use dark colors for code blocksCopy
  "featuredGroupsId": "",
  "featuredItemsGroupQuery": "",
  "galleryTemplatesGroupQuery": "title:\"Gallery Templates\" AND owner:esri_en",
  "hasCategorySchema": true,
  "hasMemberCategorySchema": false,
  "helpBase": "https://doc.arcgis.com/en/arcgis-online/",
  "helperServices": {
      "asyncClosestFacility": {
          "url": "https://logistics.arcgis.com/arcgis/rest/services/World/ClosestFacility/GPServer/FindClosestFacilities",
          "defaultTravelMode": "FEgifRtFndKNcJMJ"
      },
      "asyncFleetRouting": {
          "url": "https://logistics.arcgis.com/arcgis/rest/services/World/VehicleRoutingProblem/GPServer",
          "defaultTravelMode": "FEgifRtFndKNcJMJ"
      },
      "asyncLocationAllocation": {
          "url": "https://logistics.arcgis.com/arcgis/rest/services/World/LocationAllocation/GPServer",
          "defaultTravelMode": "FEgifRtFndKNcJMJ"
      },
Expand

Feature analysis service

Feature analysis involves using the feature analysis service to perform server-side geometric and analytic operations on feature data. This service can be accessed using ArcGIS tools or APIs to run various types of analyses. Examples include finding features, merging or overlaying features, calculating feature statistics, and identifying patterns and relationships in feature data.

Expand
Use dark colors for code blocksCopy
      "workflowManager": {
          "url": "https://workflow.arcgis.com"
      },
      "analysis": {
          "url": "https://analysis3.arcgis.com/arcgis/rest/services/tasks/GPServer"
      },
      "geoenrichment": {
          "url": "https://geoenrich.arcgis.com/arcgis/rest/services/World/GeoenrichmentServer"
      },
      "asyncGeocode": {
          "url": "https://analysis3.arcgis.com/arcgis/rest/services/tasks/GPServer"
      },
Expand

Elevation service

The elevation service provides access to authoritative DEM data hosted and managed by Esri, offering a range of analysis capabilities on elevation data. These services include dynamic world elevation image services like Terrain and TopoBathy, providing access to raw elevation data and derivative layers such as hillshade, slope, and tinted hillshade for analysis and visualization.

Expand
Use dark colors for code blocksCopy
      "defaultElevationLayers": [
          {
              "url": "https://elevation3d.arcgis.com/arcgis/rest/services/WorldElevation3D/Terrain3D/ImageServer",
              "id": "globalElevation",
              "layerType": "ArcGISTiledElevationServiceLayer"
          }
      ],
      "elevation": {
          "url": "https://elevation.arcgis.com/arcgis/rest/services/Tools/Elevation/GPServer"
      },
      "elevationSync": {
          "url": "https://elevation.arcgis.com/arcgis/rest/services/Tools/ElevationSync/GPServer"
      },
Expand

Raster analysis service

The raster analysis service provides tools and functions for performing spatial analyses on raster and imagery data. Users can access these tools to process, analyze, and visualize raster data. Tasks performed using these services include summarizing data, analyzing patterns, and creating custom processing chains using raster functions and templates.

Expand
Use dark colors for code blocksCopy
      "creditEstimation": {
          "url": "https://analysis3.arcgis.com/arcgis/rest/services/Estimate/GPServer"
      },
      "rasterAnalytics": {
          "url": "https://rasteranalysis3.arcgis.com/arcgis/rest/services/RasterAnalysisTools/GPServer"
      },
      "rasterUtilities": {
          "url": "https://rasteranalysis3.arcgis.com/arcgis/rest/services/Utilities/RasterUtilities/GPServer"
      },
      "geoanalytics": {
          "url": "https://geoanalytics3.arcgis.com/arcgis/rest/services/GeoAnalyticsTools/GPServer"
      },
      "datastoreManagement": {
          "url": "https://datastoremanagement3.arcgis.com"
      },
Expand

Geoenrichment service

The GeoEnrichment service a tool that enhances geospatial data by providing localized information about people, places, and businesses. It allows users to retrieve demographic information and other location facts for specific areas or points, enabling the enrichment of data with details like habits and lifestyles of residents, nearby businesses, postal codes, and more.

Expand
Use dark colors for code blocksCopy
      "workflowManager": {
          "url": "https://workflow.arcgis.com"
      },
      "analysis": {
          "url": "https://analysis3.arcgis.com/arcgis/rest/services/tasks/GPServer"
      },
      "geoenrichment": {
          "url": "https://geoenrich.arcgis.com/arcgis/rest/services/World/GeoenrichmentServer"
      },
      "asyncGeocode": {
          "url": "https://analysis3.arcgis.com/arcgis/rest/services/tasks/GPServer"
      },
Expand

Print service

The print service is a tool that allows users to print and preview maps directly from Map Viewer, as well as from print widgets in apps created using ArcGIS apps like ArcGIS Experience Builder and ArcGIS Instant Apps. This service enables the creation of printable documents with various layouts, including options to customize templates, add dynamic text, and include legends for a more tailored printing experience.

Expand
Use dark colors for code blocksCopy
              {
                  "source": "https://ibasemaps-api.arcgis.com",
                  "export": "https://tiledbasemaps.arcgis.com"
              }

          ]
      },
      "printTask": {
          "url": "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"
      },
      "route": {
          "url": "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World",
          "defaultTravelMode": "FEgifRtFndKNcJMJ"
      },
Expand

Route service

The route service is a tool that allows users to find the best way to navigate from one location to another or to visit multiple locations efficiently. It can determine the quickest or shortest route based on factors like traffic conditions, time windows for stops, and optimized sequences for visiting multiple locations, providing valuable routing solutions for various spatial analysis needs.

Expand
Use dark colors for code blocksCopy
          ]
      },
      "printTask": {
          "url": "https://utility.arcgisonline.com/arcgis/rest/services/Utilities/PrintingTools/GPServer/Export%20Web%20Map%20Task"
      },
      "route": {
          "url": "https://route.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World",
          "defaultTravelMode": "FEgifRtFndKNcJMJ"
      },

      "routingUtilities": {
          "url": "https://logistics.arcgis.com/arcgis/rest/services/World/Utilities/GPServer"
      },
      "serviceArea": {
          "url": "https://route.arcgis.com/arcgis/rest/services/World/ServiceAreas/NAServer/ServiceArea_World",
          "defaultTravelMode": "FEgifRtFndKNcJMJ"
      },
Expand