Description

The export image operation is performed on an image service resource. The result of this operation is an image resource. This resource provides information about the exported image, such as its URL, its width and height, and extent.

Apart from the usual response formats of html and json, users can also request a format called image while performing this operation. When users perform an export with the format of image, the server responds by directly streaming the image bytes to the client. With this approach you don't get any information associated with the exported image besides the actual image.

The mosaicProperties and viewpointProperties parameters were deprecated at 10 and not supported from 10.1 onwards. The mosaicRule parameter was added at 10. Users should use this new parameter instead of the former 2.

Support for the time and renderingRule parameters was added at 10.

Support for a new jpgpng format was also added at 10. jpgpng is the new default output format for Image Service export operation.

Users can provide arguments to the export image operation as query parameters. These parameters include the request extent, size information, interpolation, pixel type, and so on. The parameter details are provided in the parameters table below.

Parameters

{
  "mosaicMethod" : "<esriMosaicNone | esriMosaicCenter | esriMosaicNadir | esriMosaicViewpoint | 
                     esriMosaicAttribute | esriMosaicLockRaster | esriMosaicNorthwest | esriMosaicSeamline>",
  "where" : "<where>",
  "sortField" : "<sortFieldName>",
  "sortValue" : <sortValue>,
  "ascending" : <true | false>,
  "lockRasterIds" : [<rasterId1>, <rasterId2>],
  "viewpoint" : <point>,
  "fids" : [<fid1>, <fid2>],
  "mosaicOperation" : "<MT_FIRST | MT_LAST | MT_MIN | MT_MAX | MT_MEAN | MT_BLEND>"
}

{
  "mosaicMethod" : "esriMosaicLockRaster",
  "lockRasterIds" : [32, 454, 14]
}

{
  "rasterFunction" : "<rasterFunctionName>",
  "rasterFunctionArguments" : {<rasterFunctionArguments>},
  //optional parameter. For information on default 'variableNames', check the Raster Functions documentation for details. 
  "variableName" : "<variableName>"
}

Example Usage

Example 1: Export an image with the bounding box [[-141.19530416221985,-62.217823180545146] - [139.27427961579508,84.15317625109763]] in WGS 84 (4326). Response format is image.

Example 2: Export the image similar to Example 1 but request the image in Web Mercator (3857). Response format is json.

Example 3: Export an image by specifying a mosaic rule supported by the image service. (showing world temperature using the 8th raster only: August of 1950)

http://sampleserver3.arcgisonline.com/ArcGIS/rest/services/World/Temperature/ImageServer/exportImage?bbox=-180,-55.5,180,83.5&bboxSR=&size=&imageSR=&time=&format=jpgpng&pixelType=U8&noData=&interpolation=RSP_NearestNeighbor&compressionQuality=&bandIds=&mosaicRule={"mosaicMethod" : "esriMosaicLockRaster","lockRasterIds":[8]}&renderingRule=&f=image

Example 4: Export an image by specifying a rendering rule supported by the image service.

http://sampleserver6.arcgisonline.com/arcgis/rest/services/CharlotteLAS/ImageServer/exportImage?bbox=1440000.0,535000.0,1455000.0,550000.0&bboxSR=&size=400,400&imageSR=&format=jpgpng&pixelType=UNKNOWN&noData=&interpolation=RSP_BilinearInterpolation&mosaicRule=&renderingRule={"rasterFunction" : "RFTAspectColor"}&f=image

JSON Response Syntax

{
"href" : "<href>",
"width" : <width>,
"height" : <height>,
"extent" : {<envelope>}
}

JSON Response Example

{
"href" : "http://sampleserver3a.arcgisonline.com/arcgisoutput/_ags_321611040.jpg",
"width" : 937,
"height" : 489,
"extent" : {
 "xmin" : -26821417.0684016, "ymin" : -8910977.94571736, "xmax" : 26607569.5940922, "ymax" : 18972452.6604293,
 "spatialReference" : {"wkid" : 3857}
},
"scale":0
}