- URL:https://<rasteranalysistools-url>/ConvertRasterToFeature
- Version Introduced:10.5
Description
The ConvertRasterToFeature task converts a raster to a point, line, or polygon feature dataset.
Request parameters
| Parameter | Details |
|---|---|
| inputRaster (Required) | The input raster that will be converted to a feature dataset. It can be either an integer or float raster. Syntax: This parameter can be specified as a portal item ID, a URL to a raster image service layer, a cloud raster dataset, or a shared raster dataset. Examples: |
| outputName (Required) | The output feature service of the results. You define the name of the service. If output name is not supplied, the task will return a feature collection. Output name example: |
| field (Required) | A field that specifies the conversion value. Example: |
| outputType | Specifies the output type. If the input is a floating point raster, then only a point dataset can be created. If the input is an integer raster, then a Point, Line, or Polygon dataset can be created. The default is point. Example: |
| simplifyLinesOrPolygons | Specifies how the features should be smoothed. It is only available for line and polygon output. This parameter is only supported if outputType is Line or Polygon. Syntax: A Boolean value as either true or false.
Example: |
| createMultipartFeatures | Specifies whether the output polygons will consist of single-part or multipart features. Syntax: A Boolean value as either true or false.
This parameter is only supported if outputType is Polygon. Example: |
| maxVerticesPerFeature | The vertex limit used to subdivide a polygon into smaller polygons. This parameter produces similar output as created by the Dice tool. If left empty, the output polygons will not be split. This is the default. This parameter is only supported if outputType is Polygon. Example: |
| context | Contains additional settings that affect task processing. This task has the following settings:
|
| f | The response format. The default response format is html. Values: html | json | pjson |
Response
When you submit a request, the task assigns a unique job ID for the transaction.
{
"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, you use the jobId to retrieve the results. To track the status, you can make a request of the following form:
https://<raster analysis tools url>/ConvertRasterToFeature/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:
https://<raster analysis tools url>/ConvertRasterToFeature/jobs/<jobId>/results/outputFeatures
Example usage
Below is a sample request URL for ConvertRasterToFeature.
https://services.myserver.com/acrgis/rest/services/System/ConvertRasterToFeature/GPServer/submitJob
JSON Response examples
The response returns the outputFeatures parameter, which has properties for parameter name, data type, and value. The content of value depends upon the outputName parameter provided in the initial request.
If outputName was provided in the request, value contains the URL to the feature service layer
Example:
{
"paramName":"outputFeatures",
"dataType":"GPString",
"value":{"url":"<hosted feature service layer url>"}
}If outputName is not provided in the request, value contains a feature collection.
Example:
{
"paramName":"outputFeatures",
"dataType":"GPString",
"value":{"layerDefinition": {}, "featureSet": {}
}