Export Web Map Task

Description

The Export Web Map task takes the state of a web application (for example, map services, layer visibility settings, client-side graphics, and so forth) and returns either a page layout or a map without page surrounds of the specified area of interest in raster or vector format.

The input for Export Web Map is a piece of text in JavaScript object notation (JSON) format describing the layers, graphics, and other settings in the web map. The JSON must be structured according to the WebMap specification descriped in the Parameters section below.

NoteNote:

This utility service was added at 10.1.

Request Parameters

Parameter

Details

Web_Map_as_JSON

Description: A JSON representation of the state of the map to be exported as it appears in the web application.

ExportWebMap specification

Format

Description: The format in which the map image for printing will be delivered. The default value is PNG8.

Values: PNG8 | PNG32 | JPG | GIF | PDF | EPS | SVG | SVGZ

Layout_Template

Description: Either a name of a template from the list or the keyword MAP_ONLY. When the value is MAP_ONLY or is empty, the output map does not contain any page layout surroundings (for example title, legends, scale bar, and so forth).

The default value is MAP_ONLY.

f

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

Values: html | json

Examples

Sample Response from a synchronous job request:

]{
 "results": [{
   "paramName": "Output_File",
   "dataType": "GPDataFile",
   "value": {"url": "http://myserver/arcgis/rest/directories/arcgisoutput/Utilities/ExportWebMap_GPServer/_ags_c39e93a6a7d24286ad9fa3b812f23ad3.png"}
 }],
 "messages": []
}

Sample Response from an asynchronous job request:

{
  "paramName": "Output_File",
  "dataType": "GPDataFile",
  "value": {"url": "http://myserver/arcgis/rest/directories/arcgisjobs/exportwebmap_gpserver/j16f7de07afee441585f84cd788266c9c/scratch/fd67076d7a7b448282eac9ff62afac4d.pdf"}
}

7/27/2017