Create Buffers

inputLayer

(Required)

The point, line, or polygon features to be buffered.

Syntax: As described in detail in the Feature input topic, this parameter can be one of the following:

• A URL to a feature service layer with an optional filter to select specific features
• A feature collection

Examples:

• {"url": <feature service layer url>, "filter": <where clause>}
• {"layerDefinition": {}, "featureSet": {}, "filter": <where clause>}

distances

(Required if Field is not provided)

An array of double values to buffer the input features. You must supply values for either the Distances or Field parameter. You can enter a single distance value or multiple values, separating each value with a space. The units of the distance values is supplied by the Units parameter.

Examples:

• "distances": [4.0]
• "distances": [4.0, 5.0, 6.0]

field

(Required if distances is not provided)

A field on the inputLayer containing a buffer distance. Unlike the distances parameter, multiple distances are not supported on field input.

Example: "field": "Setback"

units

The linear unit to be used with the distance values specified in distances or contained in the field value.

Values: Meters | Kilometers | Feet | Miles | NauticalMiles | Yards

The default is Meters

Example: "units": "Miles"

dissolveType

Specifies how overlapping buffers are processed.

Values: None | Dissolve

	None—Overlapping areas are kept. This is the default.
	Dissolve—Overlapping areas are combined.

Example: "dissolveType": "Dissolve"

ringType

Specifies how multiple-distance buffers are processed.

Values: Disks | Rings

	Disks—Buffers are concentric and will overlap. For example, if the distances are 10 and 14, the result will be two buffers, one from 0 to 10 and one from 0 to 14. This is the default.
	Rings—Buffers will not overlap. For example, if the distances are 10 and 14, the result will be two buffers, one from 0 to 10 and one from 10 to 14.

Example:"ringType": "Disks"

sideType

Specifies the side of the line that will be buffered when buffering line features. Typically, this is both sides (Full, which is the default). Left and right are determined as if you were walking from the first x,y coordinate of the line (the start coordinate) to the last x,y coordinate of the line (the end coordinate). Specifying left or right usually means you know that the line features were created and stored in a particular direction (for example, upstream or downstream in a river network).

When buffering polygon features, you can specify whether the buffer includes or excludes the polygon being buffered.

Values: Full | Right | Left | Outside

	Full—Both sides of the line will be buffered. This is the default for line features.
	Right—Only the right side of the line will be buffered.
	Left—Only the left side of the line will be buffered.
	Outside—When buffering a polygon, the polygon being buffered is excluded in the result buffer.
	If a sideType value is not specified, the polygon being buffered is included in the result buffer. This is the default for polygon features.

sideType is enabled only for single distance buffers.

Example: "sideType": "Outside"

endType

The shape of the buffer at the end of line input features. This parameter is not valid for polygon input features. At the ends of lines, the buffer can be rounded (Round) or be straight across (Flat).

Values: Round | Flat

	Round—Buffers will be rounded at the ends of lines. This is the default.
	Flat—Buffers will be flat at the ends of lines.

Example: "endType": "Flat"

outputName

If provided, the task will create a feature service of the results. You define the name of the service. If an outputName value is not provided, the task will return a feature collection.

Syntax:

1
2
3
4
5
{
  "serviceProperties": {
    "name": "<service name>"
  }
}

In ArcGIS Online or ArcGIS Enterprise 10.9.1 and later, you can overwrite an existing feature service by providing the itemId value of the existing feature service and setting the overwrite property to true. Including the serviceProperties parameter is optional. As described in the Feature output topic, you must either be the owner of the feature service or have administrative privileges to perform the overwrite.

Syntax:

1
2
3
4
5
6
7
{

  "itemProperties": {
			"itemId": "<itemID of the existing feature service>",
			"overwrite": true
	}
}

or

1
2
3
4
5
6
7
8
9
{
"serviceProperties": {
    "name": "<existing service name>"
  },
"itemProperties": {
				"itemId": "<itemID of the existing feature service>",
				"overwrite": true
	}
}

context

The Context parameter contains the following additional settings that affect task operation:

• Extent (extent)—A bounding box that defines the analysis area. Only input features that intersect the bounding box will be analyzed.
• Output spatial reference (outSR)—The output features will be projected into the output spatial reference.

Syntax:

1
2
3
4
{
  "extent" : {extent},
  "outSR" : {spatial reference}
}

f

The response format. The default response format is html.

Values: html | json

bufferLayer

The buffer polygons.

Example:

1
{"url":"http://<analysis url>/CreateBuffers/jobs/<jobId>/results/bufferLayer"}

The result has properties for paramName, dataType, and value. The contents of the value property depend on the outputName parameter value provided in the initial request.

• If an outputName parameter value was provided, the value property contains the URL to the feature service layer.

1
2
3
4
5
{
"paramName":"bufferLayer",
"dataType":"GPString",
"value":{"url":"<hosted featureservice layer url>"}
}

• If an outputName parameter value was not provided, the value property contains a feature collection.

1
2
3
4
5
{
"paramName":"bufferLayer",
"dataType":"GPString",
"value":{"layerDefinition": {}, "featureSet": {}  }
}

See Feature output for more information about how the result layer or collection is accessed.