require(["esri/rest/geoprocessor"], (geoprocessor) => { /* code goes here */ });
import * as geoprocessor from "@arcgis/core/rest/geoprocessor.js";
esri/rest/geoprocessor
Represents a GP resource exposed by the ArcGIS REST API. A GP resource represents a single task in a GP service published using the ArcGIS Server and it supports one of the following operations dependent on how the service was set up:
- execute - for when the execution type is synchronous.
- submitJob - for when the execution type is asynchronous.
If processExtent is not set then execute and submitJob will format web requests compatiable
with ArcGIS version prior to 10.6.1.
Method Overview
| Name | Return Type | Summary | Object |
|---|---|---|---|
| Promise<object> | Sends a request to the server to execute a synchronous GP task. more details | geoprocessor | |
| Promise<JobInfo> | Submits a job to the server for asynchronous processing by the GP task. more details | geoprocessor |
Method Details
-
Sends a request to the server to execute a synchronous GP task.
The results can be retrieved using the fetchResultData(), fetchResultImage(), or fetchResultMapImageLayer() methods.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a Geoprocessing service.
params ObjectoptionalSpecifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource. For example, assume that a GP Task resource has the following input parameters:
<GPFeatureRecordSetLayer>Input_Points<GPDouble>Distance
The
paramsargument would then be an Object of the form:{ Input_Points: <FeatureSet>, Distance: <Number> }options GPOptionsoptionalspecifies the input options for the geoprocessing service return values. The
optionsargument could be an Object of the form:{ returnZ: true }requestOptions ObjectoptionalAdditional options to be used for the data request.
ReturnsType Description Promise<object> When resolved, returns an object with the following properties: { messages: <GPMessage[]>, results: <ParameterValue[]> }
-
Submits a job to the server for asynchronous processing by the GP task. The method will resolve immediately after the job has been submitted to the server. Use waitForJobCompletion() to be notified when the job has completed and optionally periodic job status.
The results can be retrieved using the fetchResultData(), fetchResultImage(), or fetchResultMapImageLayer() methods.
Parametersurl StringURL to the ArcGIS Server REST resource that represents a Geoprocessing service.
params Objectoptionalspecifies the input parameters accepted by the task and their corresponding values. These input parameters are listed in the parameters field of the associated GP Task resource. For example, assume that a GP Task resource has the following input parameters:
<GPFeatureRecordSetLayer>Input_Points<GPDouble>Distance
The
paramsargument would then be an Object of the form:{ Input_Points: <FeatureSet>, Distance: <Number> }options GPOptionsoptionalspecifies the input options for the geoprocessing service return values. The
optionsargument could be an Object of the form:{ returnZ: true }requestOptions ObjectoptionalAdditional options to be used for the data request.
ReturnsType Description Promise<JobInfo> When resolved, returns a JobInfo.