ArcGIS REST API

Convert Raster Function Template

The Convert-Raster-Function-Template task converts a raster function template between JSON and XML formats.

It takes a raster function template in any of these two formats as input to convert into the other format as specified in another input parameter.

Request URL

https://<raster utilities url>/ConvertRasterFunctionTemplate/submitJob? inputRasterFunction={"itemId":"1780d648db3545bba8661ad98df824a4"}&outputFormat=JSON

Request parameters

ParameterDescription

inputRasterFunction

The Portal Item ID, JSON or XML format of the raster function template.

Syntax: A string describes the input raster function template.

Example:

{"itemId": <portal item id>}
JSON of raster function template
XML of raster function template

outputFormat

The format the raster function template will be converted into.

Syntax:

  • XML, or
  • 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 Checking 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:

https://<raster utilities url>/ConvertRasterFunctionTemplate/jobs/<jobId>

Accessing results

When the status of the job request is esriJobSucceeded, you can access the results of the task by making a request of the following form:

http://<raster utilities url>/ConvertRasterFunctionTemplate /jobs/<jobId>/results/outputRasterFunction?f=json

ParameterDescription

outputRasterFunction

The url and/or item ID of output raster function template.

Example: {"url": "http://<raster utilities url>/ConvertRasterFunctionTemplate/jobs/<jobId>/results/outputRasterFunction"}

The result has properties for parameter name, data type, and value. The content of the value is always the output raster function itemId and/or url.

Example:

{
 "paramName": "outputRasterFunction",
 "dataType": "GPDataFile",
 "value": {"url":<url to access the raster function templates>
 }
}

outputFormat

The format the raster function template will be converted into.

Syntax:

  • XML, or
  • JSON