- URL:
- https://<rasteranalysistools-url>/ConvertRasterFunctionTemplate
- Methods:
GET
- Version Introduced:
- 10.6.1
Description
The Convert
task converts a raster function template between JSON and XML formats. Convert
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
Parameter | Details |
---|---|
| The portal item ID, or the JSON or XML format of the raster function template. Syntax: A string describes the input raster function template.
|
| The format that the raster function template will be converted into. Values: |
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 job
to periodically review the status of the job and messages as described in Checking job status. Once the job has successfully completed, use job
to retrieve the results. To track the status, you can make a request of the following form:
https://<raster analysis tools url>/ConvertRasterFunctionTemplate/jobs/<jobId>
When the status of the job request is esri
, you can access the results of the analysis by making a request of the following form:
https://<raster analysis tools url>/ConvertRasterFunctionTemplate/jobs/<jobId>/results/<output parameter>
Example usage
The following is a sample request URL for Convert
:
https://services.myserver.com/arcgis/rest/services/System/RasterAnalysisTools/GPServer/ConvertRasterFunctionTemplate/submitJob
JSON Request example
inputRasterFunction={"itemId":"1780d648db3545bba8661ad98df824a4"}
outputFormat=JSON
JSON Response syntax
The response returns the output
and output
output parameters. The output
parameter has properties for parameter name, data type, and value. The content of the value is always the output raster function item
, URL, or both. The output
parameter returns the format the raster function template has been converted into.
{
"paramName": <parameter name>,
"dataType": "GPDataFile",
"value": <url to access the raster function template>}
}
JSON Response example
{
"paramName": "outputRasterFunction",
"dataType": "GPDataFile",
"value": {"url":"https://...."}
}