Convert Raster to Feature

URL:: https://<root>/<serviceName>/RasterAnalysisTools/GPServer/ConvertRasterToFeature
Methods:: GET
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: Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 //Portal item as input raster {"itemId": <portal item id>} //URL as input raster {"url": <image service url} //Raster service as input raster {"serviceProperties": {"name":"testrasteranalysis", "serviceUrl":"https://<server name>/server/rest/services/Hosted/testrasteranalysis/ImageServer"}, "itemProperties":{"itemId":"8cfbd3ec25584d0d8f4ed23b8ff7c43b", "folderId", "sdfwerfbd3ec25584d0d8f4"} }`
`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: Use dark colors for code blocksCopy `1 2 3 { "serviceProperties": {"name": "<service name>"} }`
`field` (Required)	A field that specifies the conversion value. Example: Use dark colors for code blocksCopy `1 "field": Landuse`
`outputType` (Optional)	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: Use dark colors for code blocksCopy `1 "outputType": "Polygon"`
`simplifyLinesOrPolygons` (Optional)	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` . `true` specifies that the features will be smoothed. This is the default. `false` specifies that the features will follow the cell boundaries of the raster dataset. Example: Use dark colors for code blocksCopy `1 "simplifyLinesOrPolygons": true`
`createMultipartFeatures` (Optional)	Specifies whether the output polygons will consist of single-part or multipart features. Syntax: A Boolean value as either `true` or `false` . `true` specifies that multipart features will be created based on polygons that have the same value. `false` specifies that individual (single-part) features will be created for each polygon. This is the default. This parameter is only supported if `outputType` is `Polygon` . Example: Use dark colors for code blocksCopy `1 "createMultipartFeatures": true`
`maxVerticesPerFeature` (Optional)	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: Use dark colors for code blocksCopy `1 "maxVerticesPerFeature": 100000`
`context` (Optional)	Contains additional settings that affect task processing. This task has the following settings: Extent (`extent` )—A bounding box that defines the analysis area. Output Spatial Reference (`outSR`): The output features will be in this spatial reference. Snap Raster (`snapRaster`): The raster to which the cells of the input raster will be aligned.
`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.

Use dark colors for code blocksCopy
{
  "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:

Use dark colors for code blocksCopy
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:

Use dark colors for code blocksCopy
https://<raster analysis tools url>/ConvertRasterToFeature/jobs/<jobId>/results/outputFeatures

Example usage

Below is a sample request URL for ConvertRasterToFeature .

Use dark colors for code blocksCopy
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:

Use dark colors for code blocksCopy
{
  "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:

Use dark colors for code blocksCopy
{
  "paramName":"outputFeatures",
  "dataType":"GPString",
  "value":{"layerDefinition": {}, "featureSet": {}
}