Available with Advanced license.
- URL:https://<rasteranalysistools-url>/DownloadRaster
- Version Introduced:10.9
Description
The DownloadRaster task is used to download an image or partial image at a designated resolution. The input image service must be configured to allow pixel data download.
Request parameters
Parameter | Details |
---|---|
inputImageLayer (Required) | The input image, designated as a Portal Item ID, Image Service URL, cloud raster dataset, or shared raster dataset. At least one type of input must be provided in the JSON object. If multiple input types are available in the same JSON dictionary, the itemId has priority. The service tool supports downloading from multiple imagery layers in one request. Syntax: JSON object describes the input from raster.
|
clipSetting (Required) | The JSON geometry object used to clip the input image. The clipping geometry object can contain the shape description, extent, and clip type. Syntax: A JSON object supports three case sensitive keys: itemId, url, and uri. Example:
|
context | Contains settings that affect task execution and results. This task has the following settings:
Example:
|
f | The response format. The default response format is html. Values: html | json |
Response
When you submit a request, the task assigns a unique job ID for the transaction.
Syntax:{ "jobId": "<unique job identifier>", "jobStatus": "<job status>" }
After the initial request is submitted, you can use the jobId to periodically check the status of the job and messages, as described in Check job status. Once the job has successfully completed, use the jobId to retrieve the results. To track the status, you can make a request of the following form:
http://<RasterUtilities service url>/DownloadRaster/jobs/<jobId>
Access results
When the status of the job request is esriJobSucceeded, you can access the results of the analysis by making a request of the following form:
http://<raster utilities url>/DownloadRaster/jobs/<jobId>/results/outputRaster?token=<your token>
Parameter | Description |
---|---|
outputRaster | The output raster download link. Example:
The result has properties for parameter name, data type, and value. The content of the value is always the output raster dataset’s itemId and image service URL.
|