ArcGIS REST API

Convert Feature to Raster

Description

Convert Feature to Raster diagram

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

Request parameters

ParameterDetails
inputFeatures

(Required)

The feature layer that will be converted. The dataset can either be point, line, or polygon features.

Syntax: This parameter can be specified as one of the following: a URL to a feature service layer with an optional filter to select specific features, or a feature collection.

Input feature examples:

//Feature layer url
"inputFeature":{"url":<feature service layer url> "filter":<where clause>}

//Feature collection
"inputFeature":{"layerDefinition": {}, "featureSet":{}, "filter": <where clause>}

outputName

(Required)

The output image service name that will be created.

You can specify the name, or you can create an empty service using Portal Admin Sharing API and use the return JSON object as input to this parameter.

Syntax: A JSON object describes the name of the output or the output raster.

Output name example:

"outputName":{"serviceProperties":{"name":"testrasteranalysis"}}

Output raster examples:

//Output portal item:
"outputName":{"itemId": <portal item id>}

//Output url:
"outputName":{"url": <image service url}

//Output raster layer service:
"outputName":{"serviceProperties":
  {"name":"testrasteranalysis",
    "serviceUrl":"https://<server name>/server/rest/services/Hosted/testrasteranalysis/ImageServer"},
  "itemProperties":{"itemId":"8cfbd3ec25584d0d8f4ed23b8ff7c43b","folderId":"sdfwerfbd3ec25584d0d8f4"}
}

outputCellSize

(Required)

Specify the cell size to use for the output raster.

The default value for this parameter is the same as the analysis environment.

Supported units: Meters | Kilometers | Feet | Miles

Example:

"outputCellSize":{"distance":60,"units":meters}

valueField

The field on the input feature, either an integer or a string field, that will be converted.

Example:

"valueField": "Landuse"

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 raster will be projected into the output spatial reference.
  • Snap Raster (snapRaster): The output raster will have its cells aligned with the specified snap raster.
  • Cell Size (cellSize): The output raster will have the resolution specified by cell size.
  • Mask (mask): Only cells that fall within the analysis mask will be considered in the operation.
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>/ConvertFeatureToRaster/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>/ConvertFeatureToRaster/jobs/<jobId>/results/outputRaster

Example usage

Below is a sample request URL for ConvertFeatureRaster.

https://services.myserver.com/arcgis/rest/services/System/ConvertFeatureToRaster/GPServer/submitJob

JSON response example

The response returns the outputRaster output parameter, which has properties for parameter name, data type, and value. The content of value is always the output raster dataset itemId and the image service URL.

{
  "paramName": "outRaster",
  "dataType": "GPString",
  "value": {
    "itemId": "f121390b85ef419790479fc75b493efd", 
    "url": "https://<server name>/arcgis/rest/services/Hosted/<service name>/ImageServer"
  }
}