(Required)

The input raster that shows the direction of flow out of each 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.

//Portal item as input raster
"inputFlowDirectionRaster": {"itemId": <portal item Id>}

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

(Required)

The input pour point locations.

For a raster, this represents cells above which the contributing area, or catchment, will be determined. All cells that are not NoData will be used as source cells. For a point input, this represents locations above which the contributing area, or catchment, will be determined.

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.

//Portal item as input raster
"inPourPointData":{"itemId": <portal item Id>}

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

//Feature layer URL
"inPourPointData":{"url": <feature service layer url>}

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

(Required)

The name of the output image service 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"}
}

The field used to assign values to the pour point locations.

If the input pour point dataset is a raster, use Value. If it is a feature, use a numeric field. If the field contains floating-point values, they will be truncated into integers.

Syntax: A string that represents a field name.

"pourPointField": "pptID"

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 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.

The response format. The default response format is html.

Values: html | json | pjson