ArcGIS REST API

Clip Layer

Clip Layer workflow diagram

The Clip Layer task extracts input point, line, or polygon features that overlay the clip areas. The output is a subset of your input data based on the areas of interest.

Note:

Clip Layer was introduced in ArcGIS Enterprise 10.7.

Request URL

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

Request parameters

ParameterDescription

inputLayer

(Required)

The point, line, or polygon features that will be clipped to the areas of clipLayer 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:

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

clipLayer

(Required)

The polygon features that define the areas to which inputLayer features will be clipped.

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/StatePolygons/FeatureServer/0", "filter": "Name = 'Maine'"}

REST scripting example:

  • "clipLayer" : {"url": "https://myportal.domain.com/server/rest/services/Hosted/StatePolygons/FeatureServer/0", "filter": "Name = 'Maine'"}

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

f

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>/ClipLayer/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>/ClipLayer/jobs/<jobId>/results/output?token=<your token>&f=json

ParameterDescription

output

The inputLayer features clipped within the specified clipLayer areas. The type of feature (point, line, or polygon) is the same as the input layer.

Request example

{"url": 
"http://<analysis url>/ClipLayer/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.