Overlay Layers

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 examples

1
2
3
4
5
//REST web example
{"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'"}

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

REST examples

1
2
3
4
5
//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'"}

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

1
2
3
4
5
//REST web example
Intersect

//REST scripting example
"overlayType": "Erase"

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
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

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):

• Point - Point, Line, Polygon
• Line - Point, Line, Polygon
• Polygon - Point, Line, Polygon

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):

• Point - Point
• Line - Line
• Polygon - Polygon

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):

• 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 are written to the output layer. Identity supports the following geometries as inputs (inputLayer - overlayLayer):

• Point - Point, Polygon
• Line - Line, Polygon
• Polygon - Polygon

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):

• Point - Point
• Line - Line
• Polygon - Polygon

output

The features that are the result of the overlay. The type of feature (point, line, or polygon) depends on the input layers.

1
{"url": "https://<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.

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.