find

AMD: require(["esri/rest/find"], (find) => { /* code goes here */ });
ESM: import * as find from "@arcgis/core/rest/find";
Function: esri/rest/find
Since: ArcGIS API for JavaScript 4.19

Search a map service exposed by the ArcGIS Server REST API based on a string value. The search can be conducted on a single field of a single layer, on many fields of a layer, or on many fields of many layers.

Use FindParameters to set the parameters of the task. The result will be an instance of FindResult.

Known Limitations

The find operation is currently not supported if attempting to be used:

Method Overview

Name Return Type Summary Function
Promise<Object>more details

Sends a request to the ArcGIS REST map service resource to perform a search based on the input params.

more detailsfind

Method Details

find(url, params, requestOptions){Promise<Object>}

Sends a request to the ArcGIS REST map service resource to perform a search based on the input params.

Parameters:
url String

URL to the ArcGIS Server REST resource that represents a map service.

Autocasts from Object

Specifies the layers and fields that are used for the search.

requestOptions Object
optional

Additional options to be used for the data request (will override requestOptions defined during construction).

Returns:
Type Description
Promise<Object> Resolves to an object with the following properties:
Property Type Description
results FindResult[] An array of objects containing the result features of the Find task.
exceededTransferLimit Boolean exceededTransferLimit is included in the response only if the result exceeded the transfer limit.
Example:
let params = new FindParameters({
  layerIds: [0],
  searchFields: ["areaname"],
  outSpatialReference: { wkid: 4326 },
  returnGeometry: true
});
find(url, params).then(function(results){
  // Results contain FindResults of search
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.