The Create Buffers task creates polygons that cover a given distance from a point, line, or polygon feature. Buffers are typically used to create areas that can be further analyzed using a tool such as Overlay Layers. For example, if the question is "What buildings are within one mile of the school?", the answer can be found by creating a one-mile buffer around the school and overlaying the buffer with the layer containing building footprints. The end result is a layer of those buildings within one mile of the school.
The point, line, or polygon features to be buffered.
Syntax: As described in detail in the Feature Input topic, this parameter can be
(Required if Field 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 suppied by the Units parameter.
(Required if distances 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"
The linear unit to be used with the distance value(s) specified in distances or contained in the field value
Values: Meters | Kilometers | Feet | Miles | NauticalMiles | Yards
The default is Meters
Example: "units": "Miles"
Determines how overlapping buffers are processed.
Values: None | Dissolve
Example: "dissolveType": "Dissolve"
Determines how multiple-distance buffers are processed.
Values: Disks | Rings
When buffering line features, you can choose which side of the line to buffer. Typically, you choose 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). Choosing left or right usually means you know that your 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 choose whether the buffer includes or excludes the polygon being buffered.
Values: Full | Left | Right | Outside
Example: "sideType": "Outside"
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
Example: "endType": "Flat"
If provided, the task will create a feature service of the results. You define the name of the service. If outputName is not supplied, the task will return a feature collection.
Context contains additional settings that affect task execution. For Create Buffers, there are two settings.
The response format. The default response format is html.
Values: html | json
When you submit a request, the service 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 the topic 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:
When the status of the job request is esriJobSucceded, you can access the results of the analysis by making a request of the following form.
http://<analysis url>/CreateBuffers/jobs/<jobId>/results/bufferLayer?token=<your token>&f=json
The buffer polygons.
The result has properties for parameter name, data type, and value. The contents of value depends upon the outputName parameter provided in the initial request.
See Feature Output for more information about how the result layer or collection is accessed.