- URL:https://<geoanalytics-url>/OverlayLayers
- Version Introduced:10.6.1
Description
The OverlayLayers operation combines two or more layers into a single layer. You can think of overlay as peering through a stack of maps and creating a single map containing all the information 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 on top of what soil type?
- What mines are within abandoned military bases?
Note:
Sliver features may be excluded based on the tolerance of the processing spatial reference.
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:
REST Examples |
| 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:
REST Examples |
| overlayType (Optional) | The type of overlay to be performed. For more information on the values for this parameter, see the Overlay relationships section below. Values: Intersect | Erase | Union | Identity | SymmetricalDifference REST Examples |
| includeOverlaps (Optional) | A Boolean that specifies whether input features in the same dataset contain overlapping features. The default is true. Change this parameter to false if you don't want self-intersecting features for the input layer or the overlay layer. Setting this to false also improves performance. Note:For 10.6 and 10.6.1, this parameter is only used when overlayType is Intersect. The parameter is not used for 10.7 or later and will always support self overlapping datasets. Values: true | false REST Examples |
| outputName (Required) | The task will create a feature service of the results. You define the name of the service. REST Examples |
| context (Optional) | The context parameter contains additional settings that affect task execution. For this task, there are four settings:
|
| f | The response format. The default response format is html. Values: html | json |
Overlay relationships
The tables below describe the overlay relationships supported by the overlayType parameter.
Overlay relationships at 10.7 and later
| Relationship | Description |
|---|---|
| Intersect | Computes a geometric intersection of the input layers. Features or portions of features that overlap in both inputLayer and overlayLayer are written to the output layer. This is the default. Intersect supports the following geometries as inputs (inputLayer - overlayLayer):
|
| Erase | The features or portions of features in the inputLayer that do not overlap the features in the overlayLayer are written to the output. Erase supports the following geometries as inputs (inputLayer - overlayLayer):
|
| Union | Computes a geometric union of inputLayer and overlayLayer. All features and their attributes are written to the layer. Union supports the following geometries as inputs (inputLayer - overlayLayer):
|
| Identity | Computes a geometric intersection of the input features and identity features. Features or portions of features that overlap in both inputLayer and overlayLayer are written to the output layer. Identity supports the following geometries as inputs (inputLayer - overlayLayer):
|
| SymmetricalDifference | Features or portions of features in inputLayer and overlayLayer that do not overlap are written to the output layer. SymmetricalDifference supports the following geometries as inputs (inputLayer - overlayLayer):
|
Overlay relationships at 10.6 and 10.6.1
| Relationship | Description |
|---|---|
| Intersect | Computes a geometric intersection of the input layers. Features or portions of features that overlap in both inputLayer and overlayLayer are written to the output layer. This is the default. Intersect supports the following geometries as inputs (inputLayer - overlayLayer):
|
| Erase | The features or portions of features in the inputLayer that do not overlap the features in the overlayLayer are written to the output. Erase supports the following geometries as inputs (inputLayer - overlayLayer):
|
Example usage
The following is a sample request URL for OverlayLayers:
https://machine.domain.com/webadaptor/rest/services/System/GeoAnalyticsTools/GPServer/OverlayLayers/submitJob?&inputLayer={"url":"https://webadaptor.domain.com/server/rest/services/Hurricane/hurricaneTrack/0"}&mergeLayer={"url":"https://webadaptor.domain.com/server/rest/services/Hosted/corpusShelters/0"}&overlayType=Union&outputName=myOutput&context={"extent":{"xmin":-122.68,"ymin":45.53,"xmax":-122.45,"ymax":45.6,"spatialReference":{"wkid":4326}}}&f=jsonResponse
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 jobId to periodically check the status of the job and messages as described in Check 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:
https://<analysis-url>/OverlayLayers/jobs/<jobId>/results/output?token=<your token>&f=json
| Response | Description |
|---|---|
| output | The features that are the result of the overlay. The type of feature (point, line, or polygon) depends on the input layers. 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. See Feature output for more information about how the result layer is accessed. |