ArcGIS REST API

Convert Raster to Feature

Description

Convert Raster to Feature diagram

The Convert Raster to Feature task converts a raster to a point, line or polygon feature dataset.

Request parameters

ParameterDetails
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:

//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":"http://<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:

{
  "serviceProperties": {"name": "<service name>"}
}

field

(Required)

A field on the inputLayer will be used for the conversion. It can be any numerical (integer or float) field, or a string field.

Example:

"field": "Landuse"

outputType

The type of output to be created.

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:

"outputType": "Polygon"

simplifyLinesOrPolygons

Specifies how the features should be smoothed. It is only available for line and polygon output.

Syntax: A Boolean value as either true or false.

  • true specifies that the features will be smoothed out. This is the default.
  • false that the features will follow exactly the cell boundaries or the raster dataset.

Example:

"simplifyLinesOrPolygons": true

context

Contains additional settings that affect task execution. 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

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": {}
}