HTML Popup (Map Service/Dynamic Layer) | ArcGIS REST APIs

URL:: https://<dynamic-feature-url>/htmlPopup
Methods:: GET
Required Capability:: Query
Version Introduced:: 10.0

Description

The htmlPopup resource provides details about the HTML pop-up authored by the user using ArcGIS Pro. This resource is available when a dynamicLayer resource's htmlPopupType property is not esriServerHTMLPopupTypeNone .

Request parameters

Parameter Details

Parameter	Details
`layer` (Required)	Defines a dynamic layer. Only dynamic map layers are supported. Tip Use `gdbVersion` on a dynamic map layer definition to specify an alternate geodatabase version. Syntax Use dark colors for code blocksCopy `1 2 3 4 { "id": <layerOrTableId>, // optional "source": <layer source>, // only dynamic map layers are supported }` Example Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 { "id": 101, "source": { "type": "mapLayer", "mapLayerId": 0, "gdbVersion": "SDE.DynamicLayers" } }`
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

layer

(Required)

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

Syntax

Use dark colors for code blocksCopy
{
  "id": <layerOrTableId>, // optional
  "source": <layer source>, // only dynamic map layers are supported
}

Example

Use dark colors for code blocksCopy
{
  "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

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

Use dark colors for code blocksCopy
https://organization.example.com/<context>/rest/services/USA/MapServer/dynamicLayer/1/htmlPopup?layer={"id":101,"source":{"type":"mapLayer","mapLayerId":2}}&f=pjson

JSON Response syntax

Use dark colors for code blocksCopy
{
  "htmlPopupType": "<esriServerHTMLPopupTypeNone | esriServerHTMLPopupTypeAsURL | esriServerHTMLPopupTypeAsHTMLText>",
  "content": "<htmlContent>"
}

JSON Response example

Use dark colors for code blocksCopy
{
  "htmlPopupType": "esriServerHTMLPopupTypeAsHTMLText",
  "content": "A Sample HTML pop up."
}