Convert Raster Function Template

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

Description

The ConvertRasterFunctionTemplate task converts a raster function template between JSON and XML formats. ConvertRasterFunctionTemplate takes a raster function template in any of these two formats as input to convert the original source into the other specified format.

Request parameters

ParameterDetails

inputRasterFunction

The portal item ID, or the JSON or XML format of the raster function template.

Syntax: A string describes the input raster function template.

Use dark colors for code blocksCopy
1
{"itemId": <portal item Id>}

outputFormat

The format that the raster function template will be converted into.

Values: XML | 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>/ConvertRasterFunctionTemplate/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>/ConvertRasterFunctionTemplate/jobs/<jobId>/results/<output parameter>

Example usage

The following is a sample request URL for ConvertRasterFunctionTemplate :

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

JSON Request example

Use dark colors for code blocksCopy
1
2
inputRasterFunction={"itemId":"1780d648db3545bba8661ad98df824a4"}
outputFormat=JSON

JSON Response syntax

The response returns the outputRasterFunction and outputFormat output parameters. The outputRasterFunction parameter has properties for parameter name, data type, and value. The content of the value is always the output raster function itemId , URL, or both. The outputFormat parameter returns the format the raster function template has been converted into.

Use dark colors for code blocksCopy
1
2
3
4
5
{
   "paramName": <parameter name>,
   "dataType": "GPDataFile",
   "value": <url to access the raster function template>}
}

JSON Response example

Use dark colors for code blocksCopy
1
2
3
4
5
{
   "paramName": "outputRasterFunction",
   "dataType": "GPDataFile",
   "value": {"url":"https://...."}
}

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