ArcGIS REST API

HTML Popup (Map Service\Layer)

  • URL:http:// <feature-url>/htmlPopup
  • Required Capability:Query
  • Version Introduced:10.0

Description

The htmlPopup resource provides details about the HTML popup authored by the user using ArcGIS Desktop. This resource is available when a layer resource's htmlPopupType is not esriServerHTMLPopupTypeNone.

New in 10.1

Support for gdbVersion parameter was added. Use this parameter to specify the geodatabase version to query.

Request Parameters

ParameterDetails
f

Description: The response format. The default response format is html.

Values: html | json

gdbVersion

//This option was added at 10.1.

Description: GeoDatabase version to query. This parameter applies only if hasVersionedData property of the service and isDataVersioned property of the layer(s) queried are true.

If this is not specified, query will apply to published map's version.

Syntax: gdbVersion=<geodatabase version>

Example: gdbVersion=sde.USER1

Example Usage

Example 1:

http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/Petroleum/StantonCountyKSLeases/MapServer/0/1/htmlPopup

JSON Response Syntax

{
  "htmlPopupType" : "<esriServerHTMLPopupTypeNone | esriServerHTMLPopupTypeAsURL | esriServerHTMLPopupTypeAsHTMLText>",
  "content": "<htmlContent>"
}

JSON Response Example

{
  "htmlPopupType" : "esriServerHTMLPopupTypeAsHTMLText",
  "content": "A Sample HTML pop up." 
}