Skip To Content
ArcGIS Developers
Dashboard

HTML Popup (Map Service/Dynamic Layer)

Description

The htmlPopup resource provides details about the HTML pop-up authored by the user using ArcMap and ArcGIS Pro.

This resource is available when a dynamicLayer resource's htmlPopupType is not esriServerHTMLPopupTypeNone.

Request parameters

ParameterDetails
layer

(Required)

Defines a dynamic layer. Only dynamic map layers are supported.

Note:

Use gdbVersion on a dynamic map layer definition to specify an alternate geodatabase version.

Syntax

{
  "id": <layerOrTableId>, // optional
  "source": <layer source>, // only dynamic map layers are supported
}

Example

{
  "id": 101,
  "source": {
    "type": "mapLayer",
    "mapLayerId": 0,
    "gdbVersion": "SDE.DynamicLayers"
  }
}
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Below is a sample request URL used to access the htmlPopup resource, querying a specific dynamic map layer:

https://machine.domain.com/webadaptor/rest/services/USA/MapServer/dynamicLayer/1/htmlPopup?layer={"id":101,"source":{"type":"mapLayer","mapLayerId":2}}&f=pjson

JSON Response syntax

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

JSON Response example

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