Relationship types—REST APIs | Documentation for ArcGIS Enterprise

The following are the available relationship types for creating a relationship between items:


Relationship type	Description	Origin type	Destination type	Rule
Map2Service		Web Map	Map Service Feature Service Image Service	None
WMA2Code		Web Mapping Application	Code Attachment	compositeShare compositeDelete copyOriginShareOnAdd
Map2FeatureCollection		Web Map	Feature Collection	None
MobileApp2Code		Mobile Application	Code Attachment	compositeShare compositeDelete copyOriginShareOnAdd
Service2Data	Models the association of a derived service and its source data. The derived service is the origin of the relationship. The source data is the destination of the relationship. The source data can be a service. The relationship can be queried in either direction.	Service Item: Hosted Feature Service Map Service	Source Data: Service Definition CSV Shapefile Feature Service Tile Package Feature Collection File Geodatabase GeoJson GeoPackage Scene Package Vector Tile Package SQLite Geodatabase Microsoft Excel Compact Tile Package Image Collection	mustOwnAllItems
Service2Service	Models the association of a source service and a derived service. The source service is the origin of the relationship. The derived service is the destination of the relationship. The relationship can be queried in either direction.	Feature Service	Map Service	mustOwnAllItems
Map2AppConfig		Web Map	Application Configuration	mustOwnAllItems compositeShare compositeDelete copyOriginShareOnAdd
Item2Attachment		*	Microsoft Word Microsoft Excel Microsoft PowerPoint PDF Image Visio Document	mustOwnAllItems compositeShare compositeDelete
Item2Report		*	Microsoft Word Microsoft Excel Microsoft Excel PDF Image Visio Document
Listed2Provisioned		*	*	mustOwnAllItems compositeDelete childListing
Style2Style		Vector Tile Service	Vector Tile Service, Style	mustOwnDestinationItem
Service2Style		Vector Tile Service Style	Vector Tile Service, Style	mustOwnDestinationItem
Survey2Service	Models the relationship between a Survey123 form item to the feature service where data from the form is submitted.	Form	Feature Service	mustOwnOriginItem
Survey2Data	Models the relationship between a Survey123 form item to other items used by the survey. Includes feature services views that are read-only for use in the Survey123 website, map packages that can be downloaded and used offline, and Word templates that can be used by the Survey123 reporting functionality.	Form	Feature Service View, Web Map, Map Package, Tile Package, Vector Tile Package, Microsoft Word	mustOwnOriginItem
Service2Route	Models the relationship between a feature service containing all the routes and the route layer representing each route.	Hosted Feature Service	Route Layer	mustOwnAllItems compositeDelete
Area2Package		Map Area	Map package Tile Package SQLite Geodatabase Vector Tile Package	mustOwnAllItems compositeShare compositeDelete
Map2Area		Web Map	Map Area	mustOwnAllItems
Service2Layer		Feature Service	Feature Service	mustOwnAllItems compositeShare compositeDelete
Area2CustomPackage		Map Area	Map Package Tile Package SQLite Geodatabase Vector Tile Package	mustOwnAllItems
TrackView2Map	Models the association of a Track View to a Web Map during creation of the Track View in the Tracker web app.	Feature Service	Web Map
SurveyAddIn2Data		Survey123 Add In	*	mustOwnOriginItem
WorkforceMap2FeatureService	Models the association of a Workforce Feature Service to a Web Map during the creation of a Workforce Project.	Web Map	Workforce Project Feature Service	mustOwnAllItems Note: This relationship type is applicable to both ArcGIS Online and ArcGIS Enterprise. Support for this relationship type was added to ArcGIS Enterprise at 10.8.1.
Theme2Story	Models the association between an ArcGIS StoryMaps Theme and the ArcGIS StoryMaps that use that theme. A theme can be used by many stories, but a story uses only one theme. The relationship can be queried in either direction.	ArcGIS StoryMaps Theme	ArcGIS StoryMaps	None Note: This relationship type is applicable to both ArcGIS Online and ArcGIS Enterprise. Support for this relationship type was added to ArcGIS Enterprise at 10.9.
WebStyle2DesktopStyle	Models the association of Web Style to Desktop Style that is used to publish the Web Style.	Style	DesktopStyle	mustOwnAllItems Note: This relationship type is applicable to both ArcGIS Online and ArcGIS Enterprise. Support for this relationship type was added to ArcGIS Enterprise at 10.9.
Solution2Item	Models the association of Solution to the items created as part of the Solution.	Solution	*	None Note: This relationship type is applicable to both ArcGIS Online and ArcGIS Enterprise. Support for this relationship type was added to ArcGIS Enterprise at 10.9.
APIKey2Item	Models the association of API keys to an item on the ArcGIS for Developers item pages.	API Key	*	mustOwnAllItems Note: This relationship type is only applicable to ArcGIS Online organizations.
Mission2Item	Models the association of Mission to the items created as part of a Mission.	Mission	*	None Note: Introduced at 10.9.1. This relationship type is only applicable to ArcGIS Enterprise organizations.
Notebook2WebTool	Models the association between a notebook and the web tool published from that notebook.	Notebook	Geoprocessing service	mustOwnAllItems compositeShare Legacy: Support for compositeShare ended at ArcGIS Enterprise 11.2. compositeDelete Note: ArcGIS Notebook Server automatically manages this relationship type, so users do not need to add or delete this relationship manually. Introduced at 10.9.1. This relationship type is only applicable to ArcGIS Enterprise organizations.

Relationship rules

Each relationship type can have rules that are enforced by the server to help keep the items properly related.

compositeShare—Related items are logically treated as one shareable item.
- Prerequisites
  - Both items must be owned by the owner of the relationship.
  - Both items must be shared the same way.
- Rules
  - If the origin item is shared, the destination item is shared the same way.
  - Sharing of the destination item is not allowed.
compositeDelete—Related items are logically treated as one item upon deletion.
- Prerequisites
  - Both items must be owned by the owner of the relationship.
- Rules
  - If the origin item is deleted, the destination item is deleted.
  - If the destination item is deleted, the origin item is not affected.
copyOriginShareOnAdd—The destination item inherits all the sharing permissions of the origin item and is an overwrite of the destination item permissions. This rule applies to addItem with the relationship call.
mustOwnOriginItem—The creator of the relationship must own the origin item.
mustOwnDestinationItem—The creator of the relationship must own the destination item.
mustOwnAllItems—The creator of the relationship must own both related items.
childListing—Both the source (parent) and the destination (child) items must be listed: the parent publicly and the child privately.

Feedback on this topic?

Note:

Note:

Note:

Note:

Note:

Note:

Legacy:

Note:

Relationship rules

In this topic