search: Search

q

The query string used to search.

See Search reference for advanced options.

Example:

1
q=redlands+map

bbox

The bounding box for a spatial search defined as minx, miny, maxx, or maxy. Spatial search is an overlaps/intersects function of the query bbox and the extent of the document. Documents that have no extent (for example, .mxd, .3ds, and .lyr) will not be found when doing a bbox search. The document extent is assumed to be in the WGS84 geographic coordinate system.

Example:

1
bbox=-118,32,-116,34

filter

Structured filtering is accomplished by specifying a field name followed by a colon and the term you are searching for with double quotation marks. It allows the passing in of application-level filters based on the context. Use an exact keyword match of the expected value for the specified field. Partially matching the filter keyword will not return meaningful results.

See Search reference for advanced options.

Example:

1
filter=type:"Web map"

categories

A JSON array or comma-separated list of up to eight organization content categories to search items. The exact full path of each category is required, and an OR relationship between the categories must be specified. Each request allows a maximum of eight categories parameters with an AND relationship between the various categories parameters called.

Example (search for items with the water or forest category in the United States):

1
2
3
//JSON array
categories: ["/Categories/Water", "/Categories/Forest"]
categories: ["/Region/US"]

categoryFilters

A comma-separated list of up to three category terms to search for items that have matching categories. Up to two categoryFilters parameters are allowed per request. This parameter cannot be used with the categories parameter to search in a request.

Example:

1
2
//Search for items with categories that include basemap or ocean
categoryFilters=basemap, ocean

start

The result number of the first entry in the result set response. The index number is 1-based. The default value of start is 1 (in other words, the first search result). The start parameter, along with the num parameter, can be used to paginate the search results.

Example:

1
2
//Returns the 11th result as the first entry in the response
start=11

num

The maximum number of results to be included in the result set response. The default value is 10, and the maximum allowed value is 100. The num parameter, along with the start parameter, can be used to paginate the search results.

Example:

1
2
//Returns a max of 50 results in the response
num=50

sortField

The field to sort by. You can also sort by multiple fields (comma separated). Sort field names are not case sensitive.

Supported sort field names are title, created, type, owner, modified, avgrating, numratings, numcomments, numviews, and scorecompleteness.

sortOrder

Describes whether the results are returned in ascending or descending order. The default is ascending.

Values: asc | desc

countFields

A comma-separated list of fields to count. The maximum count fields allowed per request is three. Supported count fields are type, access, contentstatus, and categories.

Example:

1
countFields=categories, access

countSize

The maximum number of field values to count for each countFields field. The default value is 10, and the maximum number allowed is 200.

Example:

1
countSize=200

exclude

Excludes fields from the search results. The maximum number of fields that can be excluded is 20.

Example:

1
exclude=title,culture,numViews

displaySublayers

Returns feature layers for a hosted feature service. The default is false.

Values: true | false

enriched

Introduced at ArcGIS Enterprise 11.1. Specifies whether the search results will include both literal and relevant matches or only literal matches. A literal match is defined as having the search criteria be present in an item's title or tag. A related match is defined as having a term related to the search criteria being present in an item's tag. If true, the search results will include both literal and relevant matches. If false, search results will include only those that are a literal match for the search criteria. Searches that do not include this parameter will only return literal matches.

Values: true | false

MeanPixelSize

An integer representing mean size of image pixels, in meters. The formula used to calculate this: (PixelSizeX + PixelSizeY) / 2 * unitToMeterFactor.

Example to find single-band imagery based on resolution (meters):

1
type: "Image Service" AND MeanPixelSize:[0 TO 1]

BandCount

An integer representing the number of bands in the imagery.

Example to find imagery based on band count:

1
2
3
type: "Image Service" AND bandcount:1   //Single band

type: "Image Service" AND bandcount:[3 TO 20]   //Multi-band

displayServiceProperties

Displays image service properties. The default is false.

Values: true | false

f

The response format. The default format is html.

Values: html | json | pjson

total

The total number of results that match the query. It is counted accurately up to 10,000; if the total number is greater than this value, 10,000 will be returned. The top 10,000 query results are available to retrieve through pagination.

start

The result number of the first entry in the result set for this response. The index number is 1-based.

num

The number of results included in the result set for this response.

nextStart

The next entry index if the current result set doesn't contain all results.

results

A JSON array of item objects. See the response properties of an item.

aggregations

A counts JSON object that consists of an array of objects, one for each countFields value requested. Each count field object has fieldName and fieldValues properties with fieldName representing the count field and fieldValues consisting of an array for each field value along with its corresponding count.

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
34
35
36
37
38
{
  "counts": [
    {
      "fieldName": "contentstatus",
      "fieldValues": [
        {
          "value": "deprecated",
          "count": 4
        },
        {
          "value": "org_authoritative",
          "count": 2
        }
      ]
    },
    {
      "fieldName": "access",
      "fieldValues": [
        {
          "value": "private",
          "count": 59
        },
        {
          "value": "public",
          "count": 15
        },
        {
          "value": "account",
          "count": 6
        },
        {
          "value": "shared",
          "count": 2
        }
      ]
    }
  ]
}

serviceProperties

An array of image service properties.

Example:

1
2
3
4
5
6
7
8
9
10
11
12
13
 "serviceProperties":
{
   "bandCount": 7,
   "meanPixelSize": 30,
   "tags":
      [
         "hasMultidimensions",
         "allowAnalysis",
         "pixelTypeF32",
         "dataTypeGeneric",
         "sourceTypeDataset"
      ]
  }