Generate Raster

URL:
https://<rasteranalysistools-url>/GenerateRaster
Methods:
GET
Version Introduced:
10.6.1

Description

Generate Raster diagram

The GenerateRaster task is a service that allows you to execute raster analysis on a distributed server deployment. The analysis can be specified either with a predefined server raster function keyword or by giving a JSON object representation of a raster function chain.

Request parameters

ParameterDetails

rasterFunction

(Required)

Performs analysis on the input raster dataset. The value can be a string keyword for predefined raster functions such as NDVI, a JSON object that describes a raster function chain with built-in functions that are recognized by the server, or the contents of a raster function template file (*.rft.xml) . See the complete list of raster analysis functions you can execute on a distributed server.

outputName

(Required)

The location where the service will generate the output raster.

Syntax: A JSON object describes the output raster.

Example:

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
9
10
//Portal Item ID
{"itemId": <portal item id>}

//Image Service URL
{"url": <image service url}

//Service Properties
{"serviceProperties":{"name":"testrasteranalysis",
  "serviceUrl":"https://<server name>/server/rest/services/Hosted/testrasteranalysis/ImageServer"},
  "itemProperties":{"itemId":"8cfbd3ec25584d0d8f4ed23b8ff7c43b", "folderId", "sdfwerfbd3ec25584d0d8f4",: }}

functionArguments

The JSON string that specifies the raster function argument value. This parameter is optional because the argument value can also be defined in the function template. The rasterArguments parameter supports the RasterInfo argument for all raster functions. The information stored in RasterInfo allows you to specify the output raster dataset's properties such as cell size, extent, and nodata value.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
  "Raster": {
    "itemId": <portal item id>,
    "url": <image service url>,
    "uri": <cloud raster uri or shared data path>
  },
  "ResamplingType": 1
}

outputRasterProperties

Sets the output raster's key metadata properties.

Use dark colors for code blocksCopy
1
{"SensorName": "Landsat 8", "CloudCover": 20}

context

Contains the additional setting Output Spatial Reference (outSR ), which specifies where the output will be projected in the output spatial reference.

Use dark colors for code blocksCopy
1
{"outSR": {spatial reference}}

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:

Use dark colors for code blocksCopy
1
2
3
4
{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}

After the initial request is submitted, you can use jobId to periodically review the status of the job and messages as described in Checking job status. Once the job has successfully completed, use jobId to retrieve the results. To track the status, you can make a request of the following form:

Use dark colors for code blocksCopy
1
https://<raster analysis tools url>/GenerateRaster/jobs/<jobId>

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:

Use dark colors for code blocksCopy
1
https://<raster analysis tools url>/GenerateRaster/jobs/<jobId>/results/outRaster

Example usage

The following is a sample request URL for GenerateRaster :

Use dark colors for code blocksCopy
1
https://services.myserver.com/arcgis/rest/services/System/RasterAnalysisTools/GPServer/GenerateRaster/submitJob

JSON Request example

Use dark colors for code blocksCopy
1
2
3
4
rasterFunction=NDVI&
outputName={"itemId": "780d648db3545bba8861ad98df824a4"}&
functionArguments={"Raster": {"itemId": "04180233981a4b978755d854687e149e"},"VisibleBandID":"3","InfraredBandID":"4"}&
outputRasterProperties={"SensorName": "Landsat 8", "CloudClover": 20}

JSON Response example

The response returns the output parameter, which has properties for parameter name, data type, and value. The content of value is always the output raster dataset itemId and the image service URL.

Use dark colors for code blocksCopy
1
2
3
4
5
6
7
8
{
    "paramName": "outRaster",
    "dataType": "GPString",
    "value": {
        "itemId": "f121390b85ef419790479fc75b493efd",
        "url": "https://<server name>/arcgis/rest/services/Hosted/<service name>/ImageServer"
    }
}

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.