ArcGIS REST API - ArcGIS Services

Overlay Layers

The Overlay Layers task combines two or more layers into one single layer. You can think of overlay as peering through a stack of maps and creating a single map containing all the information found in the stack. Overlay is used to answer one of the most basic questions of geography: What is on top of what? The following are examples:

What parcels are within the 100-year floodplain? ("Within" is another way of saying "on top of.")
What land use is within what soil type?
What mines are within abandoned military bases?

Note:

Overlay Layers was introduced in ArcGIS Enterprise 10.6.1.

Note:

Sliver features may be excluded based on the tolerance of the processing spatial reference.

Request URL

http://<analysis url>/OverlayLayers/submitJob

Request parameters

Parameter

Description

inputLayer

(Required)

The point, line, or polygon features that will be overlaid with the overlayLayer features.

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 web example:

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

REST scripting example:

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

overlayLayer

(Required)

The features that will be overlaid with the inputLayer features.

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

overlayType

The type of overlay to be performed.

Values: Intersect | Erase

The following table outlines the overlay relationships supported at 10.6 and 10.6.1.


Intersect	Computes a geometric intersection of the input layers. Features or portions of features that overlap in both inputLayer and overlayLayer will be written to the output layer. This is the default. Intersect supports the following geometries as inputs (inputLayer — overlayLayer): Point — Point Line — Line Polygon — Polygon
Erase	Only those features or portions of features in inputLayer that are not within the features in overlayLayer are written to the output. Erase supports the following geometries as inputs (inputLayer — overlayLayer): Point — Point Line — Line Polygon — Polygon

The following table outlines the overlay relationships supported at 10.7 and later.


Intersect	Computes a geometric intersection of the input layers. Features or portions of features that overlap in both inputLayer and overlayLayer will be written to the output layer. This is the default. Intersect supports the following geometries as inputs (inputLayer — overlayLayer): Point — Point, Polyline, Polygon Polyline — Point, Polyline, Polygon Polygon— Point, Polyline, Polygon
Erase	Only those features or portions of features in inputLayer that are not within the features in overlayLayer are written to the output. Erase supports the following geometries as inputs (inputLayer — overlayLayer): Point — Point Line — Line Polygon — Polygon
Union	Computes a geometric union of the inputLayer and overlayLayer. All features and their attributes will be written to the layer. Union supports the following geometries as inputs (inputLayer — overlayLayer): Polygon — Polygon
Identity	Computes a geometric intersection of the input features and identity features. Features or portions of features that overlap in both inputLayer and overlayLayer will be written to the output layer. Identity supports the following geometries as inputs (inputLayer — overlayLayer): Point — Point, Polygon Polyline — Polyline, Polygon Polygon— Polygon
SymmetricalDifference	Features or portions of features in the inputLayer and overlayLayer that do not overlap will be written to the output layer. Symmetrical Difference supports the following geometries as inputs (inputLayer — overlayLayer): Point — Point Polyline — Polyline Polygon— Polygon

REST web example: Intersect

REST scripting example: "overlapType": "Erase"

includeOverlaps

Determines whether input features in the same dataset contain any overlapping features. The default is true. This option should only be modified if you're not interested in self-intersection between features for the input layer and self-intersection between features for the overlay layer. Setting this value to false will improve performance. This parameter is only used when includeOverlaps is Intersect with 10.6 and 10.6.1.

Values: true| false

REST web example: Intersect

REST scripting example: "includeOverlaps": "Intersect"

outputName

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

REST web example: myOutput

REST scripting example: "outputName" : "myOutput"

context

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:
{
"extent" : {extent},
"processSR" : {spatial reference},
"outSR" : {spatial reference},
"dataStore":{data store}
}

The response format. The default response format is html.

Values: html | json

Response

When you submit a request, the service assigns a unique job ID for the transaction.

Syntax:
{
"jobId": "<unique job identifier>",
"jobStatus": "<job status>"
}

After the initial request is submitted, you can use jobId to periodically check the status of the job and messages as described in Checking job status. Once the job has successfully completed, use jobId to retrieve the results. To track the status, you can make a request of the following form:

https://<analysis url>/OverlayLayers/jobs/<jobId>

Access results

When the status of the job request is esriJobSucceeded, you can access the results of the analysis by making a request of the following form:

http://<analysis url>/OverlayLayers/jobs/<jobId>/results/output?token=<your token>&f=json


Parameter	Description
output	The features that are the result of the overlay. The type of feature (point, line, or polygon) depends on the input layers. Request example: `{"url": "http://<analysis url>/OverlayLayers/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. `{ "paramName":"output", "dataType":"GPRecordSet", "value":{"url":"<hosted featureservice layer url>"} }` See Feature output for more information about how the result layer is accessed.