Find

searchText

(Required)

The search string. This is the text that is searched across the layers and fields the user specifies.

Example

1
searchText=Los

contains

If false , the operation searches for an exact match of the searchText string. An exact match is case sensitive. Otherwise, it searches for a value that contains the searchText provided. This search is not case sensitive. The default is true .

Values: true | false

searchFields

The names of the fields to search. The fields are specified as a comma-separated list of field names. If this parameter is not specified, all fields are searched.

Syntax

1
2
//Where fieldName1 and fieldName2 are the field names returned by the
searchFields=<fieldName1>,<fieldName2>

Example

1
searchFields=AREANAME,SUB_REGION

sr

The well-known ID of the spatial reference of the output geometries. If sr is not specified, the output geometries are returned in the spatial reference of the map.

layerDefs

Allows you to filter the features of individual layers in the exported map by specifying definition expressions for those layers. A definition expression for a layer that is published with the service will be always honored.

Syntax

1
2
//Where layerId1 and layerId2 are the layer ids returned by the map service resource
{"<layerId1>": "<layerDef1>", "<layerId2>": "<layerDef2>"}

Example

1
{"0":"POP2000 > 1000000","5":"AREA > 100000"}

layers

(Required)

The layers on which to perform the find operation. The layers are specified as a comma-separated list of layer IDs.

Syntax

1
2
//Where layerId1 and layerId2 are the layer ids returned by the
layers=<layerId1>,<layerId2>

Example

1
layers=2,4,7

returnGeometry

If true , the resultset includes the geometries associated with each result. The default is true .

Values: true | false

maxAllowableOffset

This option can be used to specify the maximum allowable offset to be used for generalizing geometries returned by the find operation. The maxAllowableOffset is in the units of the sr . If sr is not specified, the maxAllowableOffset is assumed to be in the unit of the spatial reference of the map.

Example

1
maxAllowableOffset=2

geometryPrecision

This option can be used to specify the number of decimal places in the response geometries returned by the find operation. This applies to x- and y-values only (not m- or z-values).

Example

1
geometryPrecision=3

dynamicLayers

Use the dynamicLayers property either to modify the data source of existing layers in the current map service or to add new layers. The new layer should have its source pointing to one of the registered workspaces that was defined at the time the map service was created. When defining a dynamic layer, the source is required.

Syntax

1
2
3
4
5
6
7
8
9
10
11
12
[
  {
    "id": <layerOrTableId>,
    "source": <layer source>,
    "definitionExpression": "<definitionExpression>"
  },
  {
    "id": <layerOrTableId>,
    "source": <layer source>,
    "definitionExpression": "<definitionExpression>"
  }
]

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
[
  {
    "id": 501,
    "source":
    {
      "type": "mapLayer",
      "mapLayerId": 0
    }
  },
  {
    "id": 502, //add a new layer from registered workspace
    "source":
    {
      "type": "dataLayer",
      "dataSource":
      {
        "type": "table",
        "workspaceId": "MAP",
        "dataSourceName": "MAP.user1.Taxlots"
      }
    }
  },
  {
    "id": 503, //change the Version of existing map service layer
    "source":
    {
      "type": "mapLayer",
      "mapLayerId": 1,
      "version": "USER1"
    },
    "definitionExpression": "neighborhood = 'French Quarter'"
  }
]

returnZ

If true , z-values will be included in the results if the features have z-values. Otherwise, z-values are not returned. The default is true .

returnM

If true , m-values will be included in the results if the features have m-values. Otherwise, m-values are not returned. The default is false .

gdbVersion

Switch map layers to point to an alternate geodatabase version.

Syntax

1
gdbVersion=<geodatabase version>

Example

1
gdbVersion=sde.USER1

returnUnformattedValues

This option was added at 10.5. If true , the values in the result will not be formatted; in other words, numbers will be returned as is and dates will be returned as epoch values, and subtype and domain values will be returned as numeric values instead of descriptions. The default value is false, making numbers and dates formatted based on the server's setting.

Values: true | false

returnFieldName

This option was added at 10.5. If true , field names will be returned instead of field aliases. The default value is false . For layers with joins, fully qualified names will be returned.

Values: true | false

datumTransformations

This option was added at 10.5. Use this parameter to apply one or more datum transformations to the map when sr is different than the map service's spatial reference. It is an array of transformation elements. Transformations specified here are used to project features from layers within a map service to sr .

For a list of valid datum transformation ID values and well-known text strings, see Using spatial references. For more information on datum transformation, see the transformation parameter in the Project operation.

Syntax

1
2
3
4
5
//WKID
datumTransformations=[wkid1, wkid2]

//datum
datumTransformations=[{<dt1>}, {<dt2>}]

Examples

1
2
3
4
5
//To apply multiple transformations
datumTransformations=[1623, 4078]

//To apply multiple transformations including a composite transformation
datumTransformations=[{"wkid":108889}, {"geoTransforms":[{"wkid":108889,"transformForward":true},{"wkid":1622,"transformForward":false}]}]

mapRangeValues

This option was added at 10.5. It allows you to filter features in the exported map from all layers that are within the specified range instant or extent.

Syntax

1
2
3
4
5
6
7
8
9
10
[
  {
    "name": "<rangeName1>",  //range id
    "value": <value> | [<value1>, <value2>]  //single value or a value-range
  },
  {
    "name": "<rangeName2>",
    "value": <value> | [<value3>, <value4>]
  }
]

Example

1
2
3
4
5
6
7
8
9
10
11
[
  {
    "name" : "salinity",
    "value" : 5  //a range instant (or single) value passed

  },
  {
    "name" : "elevation",
    "value" : [1000, 1500] //a range extent is passed
  }
]

layerRangeValues

This option was added at 10.5. It allows you to filter features for each individual layer that are within the specified range instant or extent.

Syntax

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
  "<layerId1>": [
    {
      "name": "<rangeName1>",  //range id
      "value": <value> | [<value1>, <value2>]  //single value or a value-range
    },
    {
      "name": "<rangeName2>",
      "value": <value> | [<value3>, <value4>]
    }
  ],
  "<layerId2>": [
    {
      "name": "<rangeName1>",
      "value": <value> | [<value1>, <value2>]

    }
  ]
}

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "0": [
    {
      "name": "salinity",
      "value": 5            //a range instant (or single) value passed
    },
    {
      "name": "elevation",
      "value": [1000, 1500] //a range extent is passed
    }
  ],
  "1": [
    {
      "name": "floor",
      "value": [null, 5]   //selects features with values <= 5
    }
  ]
}

layerParameterValues

This option was added at 10.5. It allows you to filter the features of individual layers by specifying a value or values to an array of preauthored parameterized filters for those layers. When a value is not specified for any parameter in a request, the default value, which is assigned during authoring time, gets used instead. When a parameterInfo allows multiple values, you must pass them in an array.

Syntax

1
2
3
4
5
6
7
8
9
10
11
[
   {
     "<layerId1>": {
       "<parameterName1>": <value>, //when the multipleValues=false in the parameterInfo
       "<parameterName2">: [<value1> | <value2>]  //when the multipleValues=true in the parameterInfo
     },
     "<layerId2>": {
       "<parameterName3>": <value>
    }
  }
]

Example

1
2
3
4
5
6
7
8
9
10
11
[
   {
     "0": {
       "floor": 10,
       "incidentDate": 1475877014000  //date time value needs to be passed in as epoch value
     },
     "1": {
       "crimeType": ["burglary", "theft"]
    }
  }
]

historicMoment

This option was added at 10.6.1. This is the historic moment to find. This parameter applies only if the layer is archiving enabled and the supportsQueryWithHistoricMoment property is set to true . This property is provided in the layer resource. If historicMoment is not specified, the search query will apply to the current features.

Syntax

1
historicMoment=<Epoch time in milliseconds>

Example

1
historicMoment=1199145600000

clipping

This parameter was added at 10.8. It allows you to mask out layers outside of the clip polygon in the exported map. Clipping can mask out any layer type, for example, feature layers, raster layers, and TIN layers. Optionally, you can use excludedLayers to exclude layers from being clipped.

Syntax

1
2
3
4
5
{
  "geometryType": "<esriGeometryPolygon | esriGeometryEnvelope>",
  "geometry": {<geometry>},
  "excludedLayers": [<layerId>, <layerId>] //optional
}

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "geometryType": "esriGeometryPolygon",
  "geometry": {
    "spatialReference": {
      "wkid": 102008
    },
    "rings": [
      [
        [-816126, 216280],
        [-565859, 199948],
        [-607349, -50318],
        [-785229, -38842],
        [-816126, 216280]
      ]
    ]
  },
  "excludedLayers": [1, 4] //optional
}

spatialFilter

This parameter was added at 10.8. It allows you to filter out features from all features layers based on the input spatial filter. It is similar to layerDefs , but instead of using an attribute filter, map service uses a spatial filter to determine which features can be queried.

Syntax

1
2
3
4
5
6
7
{
  "spatialRel": "<esriSpatialRelIntersects | esriSpatialRelContains | esriSpatialRelCrosses | esriSpatialRelEnvelopeIntersects
                | esriSpatialRelIndexIntersects | esriSpatialRelOverlaps | esriSpatialRelTouches
                | esriSpatialRelWithin | esriSpatialRelRelation>", //default = esriSpatialRelIntersects
  "geometryType": "<esriGeometryPoint | esriGeometryMultipoint | esriGeometryPolyline | esriGeometryPolygon | esriGeometryEnvelope >",
  "geometry": { <geometry> }
}

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "spatialRel" : "esriSpatialRelIntersects",
  "geometryType" : "esriGeometryPolygon",
  "geometry": {
    "spatialReference": {
      "wkid": 102008
    },
    "rings": [
      [
        [-816126, 216280],
        [-565859, 199948],
        [-607349, -50318],
        [-785229, -38842],
        [-816126, 216280]
      ]
    ]
  }
}

f

The response format. The default response format is html .

Values: html | json | pjson