geoprocessor | References | ArcGIS Maps SDK for JavaScript

import { execute, submitJob } from "@arcgis/core/rest/geoprocessor.js";

Since: ArcGIS Maps SDK for JavaScript 4.19

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 compatible with ArcGIS version prior to 10.6.1.

See also

Functions

Name	Return Type	Object
`execute`	`Promise<object>`
`submitJob`	`Promise<JobInfo>`

execute

Function

Sends a request to the server to execute a synchronous GP task.

The results can be retrieved using the JobInfo.fetchResultData(), JobInfo.fetchResultImage(), or JobInfo.fetchResultMapImageLayer() methods.

Signature: execute (url: string, params?: object | null, options?: GPOptions, requestOptions?: RequestOptions): Promise<object>

Parameters

Parameter	Type	Description
url	`string`	URL to the ArcGIS Server REST resource that represents a Geoprocessing service.
params	`object \| null`	Specifies 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 `params` argument would then be an Object of the form: `{ Input_Points: <FeatureSet>, Distance: <Number> }`
options	`GPOptions`	specifies the input options for the geoprocessing service return values. The `options` argument could be an Object of the form: `{ returnZ: true }`
requestOptions	`RequestOptions`	Additional options to be used for the data request.

Returns

Promise<object>

When resolved, returns an object with the following properties:

{
  messages: <GPMessage[]>,
  results: <ParameterValue[]>
}

See the GPMessage and ParameterValue classes for more information about the information in this object.

submitJob

Function

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 JobInfo.waitForJobCompletion() to be notified when the job has completed and optionally periodic job status.

The results can be retrieved using the JobInfo.fetchResultData(), JobInfo.fetchResultImage(), or JobInfo.fetchResultMapImageLayer() methods.

Signature: submitJob (url: string, params?: object, options?: GPOptions, requestOptions?: RequestOptions): Promise<JobInfo>

Parameters

Parameter	Type	Description
url	`string`	URL to the ArcGIS Server REST resource that represents a Geoprocessing service.
params	`object`	specifies 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 `params` argument would then be an Object of the form: `{ Input_Points: <FeatureSet>, Distance: <Number> }`
options	`GPOptions`	specifies the input options for the geoprocessing service return values. The `options` argument could be an Object of the form: `{ returnZ: true }`
requestOptions	`RequestOptions`	Additional options to be used for the data request.

Returns: Promise<JobInfo>
When resolved, returns a JobInfo.