Image Service Download method

Gets a list of downloadable files of the original images and returns an array of ImageServerDownloadResult value objects for a given set of catalog item IDs.


Download(FIDSet FIDSet, Geometry Geometry, string Format)





A list of catalog item IDs to download.


The geometry used to clip the raw image.


Format of downloadable rasters when clipping actually happens.


Return Value


An array of ImageServerDownloadResult objects.




For a given set of catalog item IDs, this method returns a list of URLs of the files that contribute to the raster catalog items for downloading. If clipping geometry and raster format specified, the selected rasters will be clipped on server to the specified raster format and a list of URLs of the clipped raster files returns.


Each ImageServerDownloadResult object returned contains a downloadable file and its size in bytes.


The number of items that can be downloaded is defined in the image service configuration. One item might be corresponding to multiple files. For example a raster of a pan-sharpened image service consists of a single band raster dataset and a multiple band raster dataset, where each dataset might consist of multiple files such as an image file, a world file, and a pyramid file. The returned downloadable files can be URLs (e.g. http:// or ftp://) that are directly downloadable from a remote server. They can also be files that are known only to the image service. In this case, GetFile should be used to prepare the file for download and get a public URL.


Downloading formats of folder structure, for example ESRI GRID, is not supported.


Format conversion only works with the clipped rasters. If the source raster is completely contained by the clip extent, there is no clip occurring and source the raster formats will be used for download. If a raster can not be clipped (converted) into a given format, because of mismatch in pixel type, number of bands, etc., the raster will be clipped to TIFF. A geodatabase raster will be downloaded to TIFF.