Items and item types

Portals allows users to store and share a variety of items. Each item has a type, such as Web Map or Feature Service, and a set of type keywords that provide additional information on the characteristics of the type.

Items can be classified into two broad type categories based on their reach: web content and desktop content.

Web content is content that can be actively consumed across all client platforms including web browsers, mobile devices, tablets, and desktops.

Desktop content is primarily consumed by desktop applications and needs to be published as geospatial web services before it can be widely consumed over the web. The portal can be used to store and share this content among users who can download the content and use it locally.

Web and mobile applications that work with content including the arcgis.com web site, may present only web accessible content by default.

Within each of the web and desktop content categories, items can be classified as maps, layers, styles, tools, applications, and datafiles based on the primary use that is made of the item.

Maps display geospatial information and consist of a set of Layers. Each layer corresponds to an information feed and represents a specific theme or kind of information such as buildings, roads, or satellite imagery. A map and its layers can include authored behavior such as pop-up windows. Styles contain symbols, symbol primitives (like colors), and layout elements like north arrows and scale bars. Tools can be used or applied to the map to reveal additional information. Applications bring a map to life with additional application-specific behavior and context. Datafiles can be stored and shared and, in certain cases, published as information feeds.

In the context of the web, maps correspond to web maps, layers correspond to feeds corresponding to a variety of geospatial content services, tools correspond to a variety of geospatial task services, applications correspond to a variety of web and mobile mapping applications, and datafiles correspond to content that can be published to create geospatial services.

In the context of the desktop, maps correspond to map packages and map documents, layers to layer packages, tools to geoprocessing and locator packages, applications to add-ins and other extensions, styles to desktop styles, and datafiles to a variety of files that can be shared via the portal.

Each item in a portal is a REST resource with its own URL. In addition to type and typekeywords, an item has additional properties including Title, Description, Tags, and Thumbnail that are described as part of the item resource.

The set of types supported by the system is shown in the following table. The addItem API requires the caller adding an item to specify the type of the item, which must be drawn from one of the types described below. The type keywords corresponding to that item are added automatically and assist users in searching for the item.

Depending on its type, an item may have either a child data resource, <em><itemURL>/data</em>, that contains the associated data for the item or a property named url that contains the URL of the content corresponding to the item. The following table indicates, for each item type, if it has associated data that is accessible via the child data resource.

Web Content

Type

Data

Type Keywords

Description

Maps

Web Map

Text/JSON

Web Map, Explorer Web Map, Map, Online Map, ArcGIS Online, Collector, Offline

Web map authored using the arcgis.com Javascript Web Map viewer. Usable by web, mobile, and desktop clients.

Collector refers to a web map that is Collector ready and will be available in Collector. The Map contains at least one editable layer that supports versioning.

Offline refers to the web map being capable of working offline. The map contains only layers that are offline capable.

CityEngine Web Scene

File

3D, Map, Scene, Web

An interactive 3D display of geospatial content created with CityEngine. (.3ws)

Web Scene

Text/JSON

3D, Map, Scene, Streaming, Web, Web Scene

An interactive 3D display of web layers containing geographic information.

360 VR Experience

Text/JSON

360, 3D, ArcGIS, City, Compare, Cube Map, Experience, Panorama, Photo, Proposals, Scenarios, Smart Cities, Spherical, Street View, Virtual Reality, VR, VR360

An 360-degree virtual reality experience that lets you explore a set of connected, geo-located panoramic 3D visualizations or photos.

Pro Map

File

ArcGIS Pro, Map, Map File, mapx

ArcGIS Pro map file (mapx)

Layers

Feature Service

Text/JSON (optional)

Data, Service, Feature Service, ArcGIS Server, Feature Access

ArcGIS Server Feature Service

The URL to the service is stored in the url property of the item. Optional JSON data contains overridden service properties.

Map Service

Text/JSON (optional)

Data, Service, Map Service, ArcGIS Server

ArcGIS Server Map Service

The URL to the service is stored in the url property of the item. Optional JSON data contains overridden service properties.

Image Service

Text/JSON (optional)

Data, Service, Image Service, ArcGIS Server, ArcGIS Image Server

ArcGIS Server Image Service

The URL to the service is stored in the url property of the item. Optional JSON data contains overridden service properties.

KML

File (optional)

Data, Map, KML

KML Network Link or KML File (.kmz)

If a file, then the data resource retrieves the file and can be used as a network link. If a network link, then the url property contains the URL for the network link.

KML Collection

File

KML Collection

A zip file containing a collection of KML/KMZ files

WMS

Data, Service, Web Map Service, OGC

OGC Web Map Service

The URL to the service is stored in the url property of the item.

WFS

Text/JSON

Data, Service, Web Feature Service, OGC

OGC Web Feature Service

The URL to the service is stored in the url property of the item.

WMTS

Text/JSON

Data, Service, Web Map Tile Service, OGC

OGC Web Map Tile Service

The URL to the service is stored in the url property of the item.

Feature Collection

Text/JSON

Feature Collection, Route Layer

A feature collection is a saved web map feature layer with layer definition (types, symbols, fields, and so on) and a feature set (the actual features).

Feature Collection Template

Text/JSON

Feature Collection, Feature Service Template, Map Notes Template

A feature collection that includes the layer definition component.

Geodata Service

Data, Service, Geodata Service, ArcGIS Server

ArcGIS Server Geodata Service

The URL to the service is stored in the url property of the item.

Globe Service

Data, Service, Globe Service, ArcGIS Server

ArcGIS Server Globe Service

The URL to the service is stored in the url property of the item.

NoteNote:

Globe services are deprecated at 10.5.

Vector Tile Service

Text/JSON

Data, Service, Vector Tile Service, ArcGIS Server, Hosted Service

A set of web-accessible vector tiles that store a vector representation of the data and the corresponding style for how tiles should be drawn.

Hosted Service refers to a hosted vector tile service.

Scene Service

Text/JSON

Data, Service, Scene Service, ArcGIS Server, Hosted Service, Point, 3DObject, IntegratedMesh, PointCloud

Cached web layers that are optimized for displaying a large amount of 2D and 3D features and can be viewed in scene viewer. Scene layers include point layers, 3D object layers, and integrated mesh layers.

Hosted Service refers to a hosted scene service.

Point, 3DObject, IntegratedMesh or PointCloud refers to the type of a scene service.

Relational Database Connection

Text/JSON

Data Store, Relational, Database, Connection, Service, Catalog, ArcGIS Server

ArcGIS Server Relational Catalog Service

The URL to the service is stored in the url property of the item.

Item represents a connection to a database for the purpose of viewing, querying and analyzing its contents.

NoteNote:

This item type is not applicable to ArcGIS Online, was added at Portal for ArcGIS 10.5.

NoteNote:
Starting at 10.5.1, Insights for ArcGIS must be installed in order to register Relational Data Store Types and create Relational Catalog Services or Relational Database Connections. Please refer to Insights for ArcGIS documentation for more information on supported databases, required vendor files, supported data types and required database privileges.

Tools

Geometry Service

Tool, Service, Geometry Service, ArcGIS Server

ArcGIS Server Geometry Service

The URL to the service is stored in the url property of the item.

Geocoding Service

Tool, Service, Geocoding Service, Locator Service, ArcGIS Server, Locator

ArcGIS Server Geocoding Service

The URL to the service is stored in the url property of the item.

Network Analysis Service

Tool, Service, Network Analysis Service, ArcGIS Server

ArcGIS Server Network Analyst Service

The URL to the service is stored in the url property of the item.

Geoprocessing Service

Tool, Web Tool (not applicable to ArcGIS Online, was added at Portal for ArcGIS 10.5), Service, Geoprocessing Service, ArcGIS Server

ArcGIS Server Geoprocessing Service

The URL to the service is stored in the url property of the item.

Workflow Manager Service

Workflow Manager, ArcGIS Server, WMServer, Workflow, JTX, Job Tracking

ArcGIS Server Workflow Manager Service

The URL to the service is stored in the url property of the item

Applications

Web Mapping Application

Text/JSON

Web Map, Map, Online Map, Mapping Site

Required: technology keywords:

JavaScript

Flex

Silverlight

Web ADF

Other; Required: purpose keywords – one of:

Ready To Use, Configurable, Code Sample

A web mapping application built using:

ArcGIS API for JavaScript

ArcGIS API for Flex

ArcGIS API for Silverlight

Java Web Application Developer Framework

.NET Web Application Developer Framework

Client must supply the appropriate technology and purpose keywords (Ready To Use, Configurable, Code Sample) when adding this item.

The URL to the service is stored in the url property of the item.

Mobile Application

Text/JSON

ArcGIS Mobile Map, Mobile Application

Required: technology keywords:

ArcGIS for iPhone

ArcGIS for Android

ArcGIS Mobile, Windows Mobile, JavaScript, Flex

Required: purpose keywords – one of:

Ready To Use, Configurable, Code Sample

A mobile application built using the:

ArcGIS for iPhone SDK

ArcGIS for Android SDK

ArcGIS Mobile SDK for the Windows Mobile Platform

JavaScript or Flex API

Client must supply the appropriate technology and purpose keywords (Ready To Use, Configurable, Code Sample) when adding this item.

The URL to the application in the app store is stored in the url property of the item.

Code Attachment

File

Code; Required: one of {Web Mapping Application, Explorer, Desktop, Mobile, iPhone}; Required if WMA: one of {Javascript, Flex, Silverlight }

The sample code associated with an application whose purpose is code sample.

Operations Dashboard Add In

File

Application, ArcGIS Operations Dashboard, Add In

ArcGIS Operations Dashboard Add In (opdashboardaddin)

Operation View

Text

Application, ArcGIS Operations Dashboard, ArcGIS Operation View

The definition of data, tools, widgets, and layout that used in Operations Dashboard.

Operations Dashboard Extension

URL

Extension, Application, ArcGIS Operations Dashboard; (optional) Map Tool, Widget, Feature Action

ArcGIS Operations Dashboard Extension

NoteNote:

Only an organization administrator is able to add.

Native Application

File

Application, Native, App, Configuration

Native Application for AppStudio for ArcGIS

NoteNote:

This item type is only applicable to ArcGIS Online.

Native Application Template

File

Native Application Template

Native Application Template for AppStudio for ArcGIS

NoteNote:

This item type is only applicable to ArcGIS Online.

Native Application Installer

File

Installer, Native, App

Native Application Installer for AppStudio for ArcGIS

NoteNote:

This item type is only applicable to ArcGIS Online.

Workforce Project

Text/JSON

Workforce Project

Workforce project for managing mobile workers.

NoteNote:

This item type is only applicable to ArcGIS Online.

Form

File

xForm, Form, Survey123

Form authored using Survey123 Connect for ArcGIS usable by Survey123 for ArcGIS application.

NoteNote:

This item type is only applicable to organizational account. It was added at Portal for ArcGIS 10.4.

Insights Workbook

Text/JSON

Application, ArcGIS, Insights Workbook

Insights Workbook collects or associates all data and analytical activity for a project, capturing and maintaining relationships such as data locations and storing result layers, models, pages and cards.

NoteNote:

This item type is not applicable to ArcGIS Online, was added at Portal for ArcGIS 10.5.

Insights Model

Text/JSON

Application, ArcGIS, Insights Model

Insights model records analysis steps on an Insights Page, including adding and joining datasets, spatial analysis, data analytics and styling.

NoteNote:

This item type is not applicable to ArcGIS Online, was added at Portal for ArcGIS 10.5.

Insights Page

Text/JSON

Application, Insights Page, ArcGIS

Insights Page resides in Insights Workbook, used to connect to data and analyze related content and themes with interactive visualization.

NoteNote:

This item type is not applicable to ArcGIS Online, was added at Portal for ArcGIS 10.5.

Dashboard

Text/JSON

Dashboard, Operations Dashboard

Dashboards integrate maps, lists, charts, and gauges that help monitoring and managing daily operations.

Hub Initiative

Text/JSON

Hub, OpenData

Initiatives organize data and tools with an organization goal.

NoteNote:

This item type is only applicable to ArcGIS Online.

Hub Site Application

Text/JSON

Hub, OpenData

A customizable website that provides a focused view of an organization's items.

NoteNote:

This item type is only applicable to ArcGIS Online.

Hub Page

Text/JSON

Hub, OpenData

Hub pages provide web site pages to market Hub Initiatives and provide chart and app content.

NoteNote:

This item type is only applicable to ArcGIS Online.

App Builder Extension

URL

Widget, App Builder

App Builder Extension for Web AppBuilder for ArcGIS

URL that references custom widgets for use in Web AppBuilder apps within Portal.

NoteNote:

This item type is not applicable to ArcGIS Online, was added at Portal for ArcGIS 10.5.1.

Data Files

Symbol Set

Text/JSON

Symbol Set

A symbol set

Color Set

Text/JSON

Color Set

A color set

Shapefile

File

Data, Shapefile

A shapefile (.zip)

Can be published as a feature service using the Portal API Publish call.

File Geodatabase

File

Data, File, Geodatabase

File geodatabase (.zip)

Can be published as a feature service using the Portal API publish call.

CSV

File

Data, Text, CSV

A text file of data values separated by commas or other delimiters (.csv).

Can be published as a feature service using the Portal API Publish call.

CAD Drawing

File

Data, CAD

A Computer-Aided Design drawing comprised of a single file (.zip). Optionally, there may also be an associated WLD and/or PRJ file.

Service Definition

File

Data, Service, Service Definition

A Service Definition (.sd) that can be published to create a geospatial web service using the Portal API Publish call.

Document Link

URL

Data, Document

Link to a web resource

Microsoft Word

File

Data, Document, Microsoft Word

Microsoft Word Document (.doc, .docx)

Microsoft Powerpoint

File

Data, Document, Microsoft Powerpoint

Microsoft Powerpoint (.ppt, .pptx)

Microsoft Excel

File

Data, Document, Microsoft Excel

Microsoft Excel Document (.xls, .xlsx)

PDF

File

Data, Document. PDF

Portable Document Format (.pdf)

Image

File

Data, Image

Image Types (.jpg, .jpeg, .tif, .tiff, .png)

Visio Document

File

Data, Document, Visio Document

Visio Document (.vsd)

iWork Keynote

File

Data, Document, Mac

iWork Keynote file (.key). Must be in zip format.

iWork Pages

File

Data, Document, Mac

iWork Pages file (.pages). Must be in zip format.

iWork Numbers

File

Data, Document, Mac

iWork Numbers file (.numbers). Must be in zip format.

Report Template

File

Business Analyst, Geoenrichment, Report Template

Report template used by the geoenrichment service and Business Analyst applications to generate custom reports.

Statistical Data Collection

File

Business Analyst, Statistical Data Collection

Data collection used by the geoenrichment service and Business Analyst applications to perform data aggregation with statistical feature data.

Desktop Content

Type

Data

Type Keywords

Description

Maps

Map Document

File

Map Document, Map, 2D, ArcMap, ArcGIS Server, mxd, msd

ArcMap Document (mxd, msd)

Map Package

File

Map, 2D, Map Package, ArcMap, mpk

ArcGIS Map Package (mpk)

Mobile Basemap Package

File

Mobile, Mobile Base Package, Basemap, ArcGIS Pro, bpk

ArcGIS Mobile Basemap Package (bpk)

Mobile Map Package

File

2D, ArcGIS Pro, Locator, Map, mmpk, Mobile, Mobile Map Package, Transportation Network

ArcGIS Mobile Map Package (mmpk)

Tile Package

File

Data, Tile Package, ArcMap, ArcGlobe, tpk

Tile Package (tpk)

Vector Tile Package

File

Data, Vector Tile Package, ArcGIS Pro, vtpk

Vector Tile Package (vtpk)

Project Package

File

ArcGIS Pro, Project, Project Package

ArcGIS Project Package (ppkx)

Task File

File

ArcGIS Professional, Task Assistant, esriTasks

ArcGIS Task File (esriTasks)

ArcPad Package

File

Map, Layer, Data, ArcPad <optional, specified by the caller: ArcPad Project, ArcPad Template>

ArcPad Package (zip)

Explorer Map

File

Map, Explorer Map, Explorer Document, 2D, 3D, ArcGIS Explorer, nmf

ArcGIS Explorer Document (nmf)

Globe Document

File

Map, Globe Document, 3D, ArcGlobe, ArcGIS Server, 3dd

ArcGlobe Document (3dd)

Scene Document

File

Map, Scene Document, 3D, ArcScene, sxd

ArcScene Document (sxd)

Published Map

File

Published Map,2D,ArcReader,ArcMap,ArcGIS Server, pmf

ArcReader Document (pmf)

Map Template

File

map, template, ArcMap, ArcGIS desktop

The Map Template (.zip) contains documentation, a map, and GDB folder.

Windows Mobile Package

File

ArcGIS Windows Mobile Package, ArcGIS Windows Mobile Map, ArcGIS Windows Mobile, wmpk

ArcGIS Windows Mobile Package

Represents a map that can be opened in the ArcGIS Mobile application for the Windows Mobile platform.

Pro Map

File

ArcGIS Pro, Map, Map File, mapx

ArcGIS Pro map file (mapx)

Layout

File

ArcGIS Pro, Layout, LayoutFile, pagx

ArcGIS Pro layout file (pagx)

Project Template

File

ArcGIS Project Template, Project Template, ArcGIS Pro

ArcGIS Project Template (aptx)

Layers

Layer

File

Data, Layer, ArcMap, ArcGlobe, ArcGIS Explorer, lyr

Layer File (lyr)

Layer

File

ArcGIS Explorer, ArcGIS Pro, ArcGlobe, ArcMap, Data, Layer, Layer File, lyr, lyrx

ArcGIS Pro layer file (lyrx)

NoteNote:

Layer searches are handled by different type keywords based on the file extension.

Layer Package

File

Data, Layer Package, ArcMap, ArcGlobe, ArcGIS Explorer, lpk

Layer Package (lpk)

Explorer Layer

File

Data, Layer, Explorer Layer, ArcGIS Explorer, nmc

ArcGIS Explorer Layer (nmc)

Scene Package

File

3D, ArcGIS Pro, ArcGIS Server, Scene, Scene Package, spk, slpk

Scene Layer Package (spk, slpk)

Image Collection

File

Data, Image, Image Collection

A portable file that contains one or more images that can be published as an image service for imagery visualization and analysis.

NoteNote:

This item type is not applicable to ArcGIS Online, was added at Portal for ArcGIS 10.5.

Styles

Desktop Style

File

ArcGIS Pro, Symbology, Style, Symbols <either 2d or 3d>

ArcGIS Pro style file (stylx)

Tools

Geoprocessing Package

File

Tool, ArcGIS Desktop, ArcMap, ArcGlobe, ArcScene, Toolbox, Geoprocessing Package, Model, Script, Sharing, Result, gpk

ArcGIS Geoprocessing Package (gpk)

Geoprocessing Package (Pro version)

File

Tool, ArcGIS Pro, Toolbox, Model, Script, Result, gpkx

ArcGIS Pro Geoprocessing Package (gpkx)

Geoprocessing Sample

File

Tool, Geoprocessing, Sample <optional, specified by the caller: model or script>

Locator Package

File

Tool, ArcMap, ArcGIS Desktop, Locator Package, Geocoding, gcpk

ArcGIS Locator Package (gcpk)

Rule Package

File

Tool, Rule Package, ArcScene, 3D, rpk

ArcGIS Rule Package (rpk)

Raster function template

File

Raster, Functions, Processing, rft, srf, function template, templates, ArcGIS Pro

ArcGIS Pro raster function template

ArcGIS Pro Configuration

File

Tool, Add-in, Configuration, proConfigX, ArcGIS Pro

A customization of Pro to include a custom splash screen and startup page as well as tools, dock panes, and menus.

Applications

Workflow Manager Package

File

Tool, ArcGIS Workflow Manager, Sharing, wpk, ArcGIS Desktop

Workflow Manager Package (wpk)

Desktop Application

File

Desktop Application

Required: platform keywords: Java, .NET-Windows Desktop, OS X, Qt, WPF

Required: purpose keywords: Code Sample, Configurable, Ready to Use

Desktop Application (zip)

Desktop Application Template

File

Application, Template, ArcGIS desktop

The Desktop Application Template (zip) includes either a desktop add in or a toolbar.exe.

Code Sample

File

code, sample, <optional, specified by the caller: Java, C#, C++, C, Python, or Script>

A code sample

Desktop Add In

File

Tool, Add In, Desktop Add In, ArcGIS Desktop, ArcMap, ArcGlobe, ArcScene, esriaddin

ArcGIS Add-In (esriaddin)

Explorer Add In

File

Tool, Add In, Explorer Add In, ArcGIS Explorer, eaz

ArcGIS Explorer Layer (eaz)

ArcGIS Pro Add In

File

Tool, Add In, Pro Add In, esriaddinx

Pro Add In (esriaddinx)

7/5/2017