Group By Proximity

inputLayer (Required)

The point, line, or polygon features that will be grouped.

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

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

REST examples

1
2
3
4
5
//REST web example
inputLayer={"url": "https://myportal.domain.com/server/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter": "Month = 'September'"}

//REST scripting example
"inputLayer": {"url": "https://myportal.domain.com/server/rest/services/Hosted/hurricaneTrack/FeatureServer/0", "filter": "Month = 'September'"}

spatialRelationship (Required)

The type of relationship to group by. For more information on the values for this parameter, see the Spatial relationships section below.

Values: Intersects | Touches | NearGeodesic | NearPlanar

REST examples

1
2
3
4
5
//REST web example
spatialRelationship=Intersect

//REST scripting example
"spatialRelationship": "Touches"

spatialNearDistance (Required if spatialRelationship is NearGeodesic or NearPlanar

A double value used for the search distance to determine if features are near one another. This is only applied if NearGeodesic or NearPlanar is the selected spatialRelationship. You can enter a single distance value. The units of the distance values are supplied by the spatialNearDistanceUnit parameter.

Analysis using a Near spatial relationship requires that the targetLayer or processing extent (processSR ) have a projected coordinate system.

REST examples

1
2
3
4
5
//REST web example
spatialNearDistance=4

//REST scripting example
"spatialNearDistance": 4

spatialNearDistanceUnit (Required if spatialRelationship is NearPlanar or NearGeodesic)

The linear unit to be used with the distance value specified in spatialNearDistance. The default value is Meters.

Values: Meters | Kilometers | Feet | FeetInt | FeetUS | Miles |MilesInt | MilesUS | NauticalMiles | NauticalMilesInt | NauticalMilesUS | Yards | YardsInt | YardsUS

REST examples

1
2
3
4
5
//REST web example
spatialNearDistanceUnit=Miles

//REST scripting example
"spatialNearDistanceUnit": "Miles"

temporalRelationship (Optional)

The type of temporal relationship to group by. For more information on the values for this parameter, see the Temporal relationships section below.

Values: Intersects | Near

REST examples

1
2
3
4
5
//REST web example
temporalRelationship=Intersect

//REST scripting example
"temporalRelationship": "Erase"

temporalNearDistance (Required if temporalRelationship is Near

A double value used for the temporal search distance to determine if features are near one another. This is only applied if Near is the selected temporalRelationship parameter. You can enter a single distance value. The units of the distance values are supplied by the temporalNearDistanceUnit parameter.

REST examples

1
2
3
4
5
//REST web example
temporalNearDistance=4

//REST scripting example
"temporalNearDistance": 4

temporalNearDistanceUnit (Required if temporalRelationship is Near)

The temporal unit to be used with the distance value specified in temporalNearDistance.

Values: Milliseconds | Seconds | Minutes | Hours | Days | Weeks | Months | Years

REST examples

1
2
3
4
5
//REST web example
temporalNearDistanceUnit=Miles

//REST scripting example
"temporalNearDistanceUnit": "Hours"

attributeRelationship (Optional)

This parameter is available at ArcGIS Enterprise 11.0 or later. An attribute relationship to group features by. The attribute expression is a symmetric operation. The tool takes an input layer that's compared against itself to find groups. Because of this, the input layer is denoted as both a and b, and all expressions should include both a and b.

REST examples

1
2
3
4
5
//REST web example
"$a['REGION'] == $b['REGION']

//REST scripting example
"attributeRelationship": "Abs($a['ACCURACY'] - $b['ACCURACY']) < 2"

outputName (Required)

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

REST examples

1
2
3
4
5
//REST web example
outputName=myOutput

//REST scripting example
"outputName": "myOutput"

context (Optional)

The context parameter contains additional settings that affect task execution. For this task, there are four settings:

• Extent (extent )—A bounding box that defines the analysis area. Only those features that intersect the bounding box will be analyzed.
• Processing spatial reference (processSR )—The features will be projected into this coordinate system for analysis.
• Output spatial reference (outSR )—The features will be projected into this coordinate system after the analysis to be saved. The output spatial reference for the spatiotemporal big data store is always WGS84.
• Data store (dataStore )—Results will be saved to the specified data store. The default is the spatiotemporal big data store.

Syntax:

1
2
3
4
5
6
{
  "extent": {extent},
  "processSR": {spatial reference},
  "outSR": {spatial reference},
  "dataStore": {data store}
}

f

The response format. The default response format is html .

Values: html | json | pjson

Intersects

Computes a geometric intersection of the input layers. Features or portions of features that overlap are grouped. This is the default. Intersects supports the following geometries as inputs:

• Points
• Lines
• Polygons

Touches

A feature touches another feature if they have an intersecting vertex, but the features do not overlap. Touches supports the following geometries as inputs:

• Line
• Polygon

NearPlanar

Conceptually, these operators buffer the features using the specified distance and return all the features that intersect the join features with the buffer applied. The distance calculation uses a planar distance. NearPlanar supports the following geometries as inputs:

• Points
• Lines
• Polygons

NearGeodesic

Conceptually, these operators buffer the features using the specified distance and return all the features that intersect the join features with the buffer applied. The distance calculation uses a geodesic distance. NearGeodesic supports the following geometries as inputs:

• Points
• Lines
• Polygons

Intersects

When any part of a feature's time overlaps another. Intersects supports the following time types as inputs:

• Instants
• Intervals

Near

A feature is near another if the time is within a given temporal distance of the other feature.

• Instants
• Intervals

output

The features that are the result of the grouping with a new field called group_id that represents the grouping of features. The type of feature (point, line, or polygon) depends on the input layers.

1
{"url": "https://<analysis-url>/GroupByProximity/jobs/<jobId>/results/output"}

The result has properties for parameter name, data type, and value. The contents of value depend on the outputName parameter provided in the initial request. The value contains the URL of the feature service layer.

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

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