FRAMES | NO FRAMES Description | Parameters | Examples | Response
Download Rasters (Operation)
URL http://<imageservice-url>/download
Parent Resource Image Service


The download rasters operation is performed on an image service resource.

The download raster operation returns information (the file id) that can be used to download the raw raster files that are associated with a specified set of rasters in the raster catalog.

The file ids returned by this operation can be used to download individual files using the Raster File resource.

You can provide arguments to the download rasters operation as query parameters defined in the parameters table below.


Parameter Details
f Description: The response format. The default response format is html.

Values: html | json
rasterIds Description: A comma separated list of raster IDs whose files are to be downloaded

Example: rasterIds=37, 462
geometry Description: The geometry to apply for clipping. If specified, the selected rasters will be clipped on the server. The structure of the geometry is the same as the structure of the json geometry objects returned by the ArcGIS REST API. In addition to the JSON structures, for envelopes, you can specify the geometry with a simpler comma-separated syntax.

By default the geometry is assumed to be in the spatial reference of the image service. You can specify a different spatial reference, by using the JSON structure syntax for geometries.

  • JSON structures: geometryType=<geometryType>&geometry={geometry}
  • Envelope simple syntax: geometryType=esriGeometryEnvelope&geometry=<xmin>,<ymin>,<xmax>,<ymax>
  • geometryType=esriGeometryEnvelope&geometry={xmin: -104, ymin: 35.6, xmax: -94.32, ymax: 41}
  • geometryType=esriGeometryEnvelope&geometry=-104,35.6,-94.32,41
geometryType Description: The type of geometry specified by the geometry parameter. The geometry type can be an envelope or polygon. The default geometry type is an envelope.

Values: esriGeometryPolygon | esriGeometryEnvelope
format Description: The format of the rasters returned. If not specified, the rasters will be in their native format.

The format applies only if the clip geometry is also specified and the format will be honored only when the raster is clipped.

Valid formats include: TIFF, Imagine Image, JPEG, BIL, BSQ, BIP, ENVI, JP2, GIF, BMP,PNG

Example: format=TIFF

Example Usage

Example 1: TODO

JSON Response Syntax

"rasterFiles" : [ //the list of files that make up the rasters to be downloaded
  { //info pertaining to a single file
    //use this id to download the file using the Raster File resource
    "id" : "<fileId1>",
    "size" : <fileSize1>,
    //an array of IDs of rasters that include this file
    "rasterIds" : [ <rasterId11>, <rasterId12> ]
    "id" : "<fileId2>",
    "size" : <fileSize2>,
    "rasterIds" : [ <rasterId21>, <rasterId22> ]

JSON Response Example

{ "TODO" : "TODO" }