HTML Popup (Map Service/Layer)

URL:: https://<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 layer resource's htmlPopupType is not esriServerHTMLPopupTypeNone .

Request parameters

Parameter Details

Parameter	Details
`gdbVersion`	The geodatabase version to query. This parameter applies only if the object being queried has the `hasVersionedData` service property and the `isDataVersioned` layer property set as `true` . If this is not specified, the query will apply to the published map's version. Syntax Use dark colors for code blocksCopy `1 gdbVersion=<geodatabase version>` Example Use dark colors for code blocksCopy `1 gdbVersion=sde.USER1`
`f`	The response format. The default response format is `html` . Values: `html` \| `json` \| `pjson`

gdbVersion

The geodatabase version to query. This parameter applies only if the object being queried has the hasVersionedData service property and the isDataVersioned layer property set as true .

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

Syntax

Use dark colors for code blocksCopy
gdbVersion=<geodatabase version>

Example

Use dark colors for code blocksCopy
gdbVersion=sde.USER1

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:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/rest/services/Petroleum/StantonCountyKSLeases/MapServer/0/1/htmlPopup?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."
}