Cost Path As Polyline

inputDestinationRasterOrFeatures

(Required)

A raster or feature dataset that identifies those cells from which the least-cost path is determined to the least costly source.

If the input is an image service, it must consist of cells that have valid values (zero is a valid value) for the destinations, and the remaining cells must be assigned NoData.

Syntax: This parameter can have either a raster input or a feature input. For raster input, 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. For feature input, this parameter can be specified as either a URL to a feature service layer or a feature collection.

Raster input examples:

1
2
3
4
5
//Portal item as input raster
"inputDestinationRasterOrFeatures":{"itemId": <portal item Id>}

//URL as input raster
"inputDestinationRasterOrFeatures":{"url": <image service layer url>}

Feature input examples:

1
2
3
4
5
//Feature layer URL
"inputDestinationRasterOrFeatures":{"url": <feature service layer url>}

//Feature collection
"inputDestinationRasterOrFeatures":{"layerDefinition": {}, "featureSet": {}}

inputCostDistanceRaster

(Required)

The cost distance raster is used to determine the least-cost path from the sources to the destinations when you use a cost backlink raster for the direction input.

The Euclidean distance raster is used to determine the path from the sources to the destinations when you use a Euclidean back direction raster for the direction input.

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:

1
2
3
4
5
//Portal item as input raster
"inputCostDistanceRaster":{"itemId": <portal item id>}

//URL as input raster
"inputCostDistanceRaster":{"url": <image service layer url>}

inputCostBacklinkRaster

(Required)

The cost backlink raster is used to determine the path to return to a source via the least-cost path or the shortest path.

For each cell in the backlink, back direction, or flow direction raster, a value identifies the neighbor that is the next cell on the path from the cell to a source cell.

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.

Raster input examples:

1
2
3
4
5
//Portal item as input raster
"inputCostBacklinkRaster":{"itemId": <portal item id>}

//URL as input raster
"inputCostBacklinkRaster":{"url": <image service layer url>}

outputPolylineName

(Required)

The task will create a feature service of the results. You can define the name of the service.

Output feature service examples:

1
2
3
4
5
//REST web example
myOutput

//REST scripting example
"outputPolylineName" : "myOutput1"

pathType

A string describing the path type, which can be either BEST_SINGLE , EACH_CELL , or EACH_ZONE .

• BEST_SINGLE : For all cells on the input destination data, the least-cost path is derived from the cell with the minimum of the least-cost paths to source cells. This is the default.
• EACH_CELL : For each cell with valid values on the input destination data, a least-cost path is determined and saved on the output raster. With this option, each cell of the input destination data is treated separately, and a least-cost path is determined for each cell.
• EACH_ZONE : For each zone on the input destination data, a least-cost path is determined and saved on the output raster. With this option, the least-cost path for each zone begins at the cell with the lowest cost distance weighting in the zone.

Example:

1
"pathType": "EACH_ZONE"

destinationField

The field used to obtain values for the destination locations.

The input feature service must contain at least one valid integer field.

Example:

1
"destinationField": destinationValue

context

Contains additional settings that affect task execution.

• Output Spatial Reference (outSR )—The output raster will be projected into the output spatial reference.

f

The response format. The default response format is html .

Values: html | json | pjson