Find Existing Locations

inputLayers

(Required)

A list of layers that will be used in the expressions parameter. Only those features in the first layer will be written to the output.

Each layer in the list can be either 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>}

Example list of URLs:

1
2
3
4
5
[
    {"url": "http://someservices.arcgis.com/ees4FIJk4mpkX1ID/arcgis/rest/services/LAParkSitingData/FeatureServer/0"},
    {"url": "http://someservices.arcgis.com/ees4FIJk4mpkX1ID/arcgis/rest/services/LAParkSitingData/FeatureServer/1"},
    {"url": "http://someservices.arcgis.com/ees4FIJk4mpkX1ID/arcgis/rest/services/LAParkSitingData/FeatureServer/2"}
]

expressions

(Required)

A list of expressions. There are two types of expressions: attribute and spatial.

Example attribute expression:

1
2
3
4
5
6
7
[
 {
   "operator": "and",
   "layer": 0,
   "where": "STATUS = 'VACANT'"
 }
]

Notes:

• The operator value can be either and or or.
• The layer value is the index of the layer in the inputLayers parameter.
• The where clause must be enclosed by double quotes.
• When working with text fields, values must be in single quotes, for example, ('VACANT').
• Date fields support all queries except LIKE. Dates are strings in YYYY:MM:DD hh:mm:ss format. The following is an example using the date field ObsDate:"where": "ObsDate >= '1998-04-30 13:30:00' "

Example spatial expression:

1
2
3
4
5
6
7
8
9
10
[
 {
   "operator": "and",
   "layer": 0,
   "spatialRel": "withinDistance",
   "selectingLayer": 1,
   "distance": 10,
   "units": "miles"
 }
]

• The operator value can be either and or or.
• The layer value is the index of the layer in the inputLayers parameter. The result of the expression is features in this layer.
• The selectingLayer is the index of the layer in the inputLayers parameter that is used to define the spatial relationship with features in the layer.
• The spatialRel value is the spatial relationship. The nine spatial relationships are described in the following table:

spatialRel	Description
intersects notIntersects	A feature in layer passes the intersect test if it overlaps any part of a feature in selectingLayer, including touches (where features share a common point). intersects—If a feature in layer intersects a feature in selectingLayer, the feature in layer is included in the output. notIntersects—If a feature in layer intersects a feature in selectingLayer, the feature in layer is excluded from the output.
withinDistance notWithinDistance	The within a distance relationship uses the straight-line distance between features in layer to those in selectingLayer. withinDistance—A feature in layer is selected (included in the output) if any part is within the specified distance of a feature in selectingLayer. For example, parcels within 100 meters of a river will be included in the output. notWithinDistance—A feature in layer is excluded (not included in the output) if it is within a distance of a feature in selectingLayer. For example, parcels within 100 meters of a river will not be included in the output. You can think of this relationship as is farther away than.
contains notContains	A feature in layer passes this test if it completely surrounds a feature in selectingLayer. No portion of the contained feature can be outside the containing feature; however, the contained feature can touch the containing feature (that is, share a common point along its boundary). contains—If a feature in layer contains a feature in selectingLayer, the feature in layer is included in the output. notContains—If a feature in layer contains a feature in selectingLayer, the feature in the first layer is excluded from the output.
within notWithin	A feature in layer passes this test if it is completely surrounded by a feature in selectingLayer. The entire feature in layer must be within the containing feature; however, the two features can touch (that is, share a common point along its boundary). within—If a feature in layer is completely within a feature in selectingLayer, the feature in layer is included in the output. notWithin—If a feature in layer is completely within a feature in selectingLayer, the feature in layer is excluded from the output.
nearest	A feature in the first layer passes this test if it is nearest to a feature in the second layer. nearest—If a feature in the first layer is nearest to a feature in the second layer, the feature in the first layer is included in the output.

• The distance value is the distance to use for the withinDistance and notWithinDistance spatial relationship.
• The units value is the units to use for the distance parameter. Values: Meters | Kilometers | Feet | Yards | Miles

An expression can be a list, which denotes a group. The first operator in the group indicates how the group expression is added to the previous expression. Grouping expressions is only necessary when you need to create two or more distinct sets of features from the same layer. One way to think of grouping is that without grouping, you would have to run the FindExistingLocations task multiple times and merge the results.

The following is an example where grouping is needed:

• You have a layer representing places that contain toxic chemicals. Each feature has an attribute, CHEMICAL, containing the name of the toxic chemical known to exist at the site.
• You want to find toxic sites containing Mercury or Selenium that are near a river (layer 0).
• You also want to find toxic sites containing Benzene or Lead that are near a park (layer 1).

Example of grouping using a list:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
[
   {
       "operator": "and",
       "layer": 0,
       "spatialRel": "withinDistance",
       "selectingLayer": 1,
       "distance": 0.5,
       "units": "Miles"
   },
   [
       {
           "operator": "and",
           "layer": 0,
           "where": "CHEMICAL = 'MERCURY'"
       },
       {
           "operator": "or",
           "layer": 0,
           "where": "CHEMICAL = 'SELENIUM'"
       },
   ],
   [
       {
           "operator": "or",
           "layer": 0,
           "spatialRel": "withinDistance",
           "selectingLayer": 2,
           "distance": 0.5,
           "units": "Miles"
       },
       [
           {
               "operator": "and",
               "layer": 0,
               "where": "CHEMICAL = 'BENZENE'"
           },
           {
               "operator": "or",
               "layer": 0,
               "where": "CHEMICAL = 'LEAD'"
           }
       ]
   ]
]

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

clipFeatures

When only a portion of a feature meets the criteria, this parameter specifies whether the result includes the entire feature or only the portions of the feature that meet all criteria:

• True—Only the portions of the feature that meet all criteria will be returned. Specifying this option, is equivalent to running the DeriveNewLocations task.
• False—The entire feature will be returned provided at least a portion of the feature meets all criteria. This is the default.

This parameter is available in ArcGIS Online or ArcGIS Enterprise 11.2 and later.

1
"clipFeatures":false

resultLayer

Request example:

1
{"url":"http://<analysis url>/FindExistingLocations/jobs/<jobId>/results/resultLayer"}

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.

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

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

• If no outputName value was provided, value contains a feature collection.

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

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