Search reference

Overview

The ArcGIS Portal Directory REST API has a full-featured text search engine that allows you to create your own queries.

The portal uses a powerful search engine to index information and to allow full text searching. The search engine uses many different inputs to rank and display appropriate results. This makes search fuzzy, which is ideal for human interaction, but can cause issues when looking for specific records programmatically. For example, the order of results may vary each time a search is performed. Developers should exercise care when using search to locate specific items and groups as part of automated scripts. It is recommended to search for items and groups by their ID when possible.

The following list specifies the ArcGIS REST API search operations that are used to find items, groups, and users:

• Search
• User search
• Group search
• Group content search

Search ranking

Items are ranked on a variety of different factors including, but not limited to, the number of times search terms appear in item, view counts, and authoritative or deprecated labels.

Search terms

A query is broken up into terms and operators. There are two kinds of terms: single term and phrase. A single term is a single word, such as fire or California. A phrase is a group of words. To create a phrase, surround multiple words with double quotation marks, such as "fire maps". Single quotation marks are not supported for a multiple-word search. Multiple terms can be combined with Boolean operators to form a more complex query.

Fields

When performing a search for items or groups, you can either specify a field or use the default fields.

For items, the default fields are as follows:

• title
• tags
• snippet
• description
• type
• typekeywords

For groups, the default fields are as follows:

• id
• title
• description
• snippet
• tags
• owner

The best match is always returned. For example, a search for fires will return records containing fire. You can search any field by typing the field name followed by a colon ":" and the search term. If you don't use a field indicator, the default fields will be searched.

As an example, to search for a layer package item that has San Francisco in the title, the query would be as follows:

1
2
3
{
  title:"San Francisco" AND type:"Layer Package"
}

The example below demonstrate advanced search query:

1
https://org.arcgis.com/home/search.html?q=flood&q=flood&restrict=false&contentstatus=org_authoritative&focus=maps-webmaps&modified=last30Days&access=public

Query Vs Filter

As a general rule, filter (i.e. defined in filter parameter) should be used instead of query:

• for binary yes/no searches.
• for queries on exact values.

Query (i.e. defined in q parameter) should be used instead of filter:

• for full-text search.
• for cases where the result depends on a relevance score.

The following fields are supported for the filter parameter:

For Users

• username
• firstname
• lastname
• fullname
• email

1
filter=username:"jsmith"

For Items

• title
• tags
• typeKeywords
• type
• owner

Example:

1
filter=tags:"public"

For Groups

• title
• typeKeywords
• owner

Example:

1
filter=owner:"jsmith"

Term modifiers

A number of term modifiers are supported to provide a wide range of searching options.

Range searches

Range searches allow you to match a single field or multiple field values between the lower and upper bounds. Range queries can be inclusive or exclusive of the upper and lower bounds. Inclusive range queries are denoted by brackets ([]). Exclusive range queries are denoted by braces ({}).

For example, to find all items created between December 1, 2009, and December 9, 2009, the search expression is as follows:

1
2
3
{
  created: [1259692864000 TO 1260384065000]
}

The created field contains the date and time an item is created in UNIX time. UNIX time is defined as the number of seconds that have elapsed since midnight on January 1, 1970. The portal stores time in milliseconds, so you need to add three zeros to the end of the UNIX time.

Range searches are not reserved for date fields. You can also use range queries with nondate fields:

1
2
3
{
  owner:{arcgis_explorer TO esri}
}

This will find all items from the owners between arcgis_explorer and esri, not including arcgis_explorer and esri.

Boolean operators

Boolean operators allow terms to be combined through logic operators. The Portal API supports AND, OR, NOT, and "-" as Boolean operators. Boolean operators must be in all caps.

AND

The AND operator is the default conjunction operator. This means that if there is no Boolean operator between two terms, the AND operator is used. The AND operator performs matching where both terms exist in either the given field or the default fields. This is equivalent to an intersection using sets.

To search for an item that contains the terms recent and fires, use the following query:

1
2
3
{
  recent fires
}

or

1
2
3
{
  recent AND fires
}

OR

The OR operator links two terms and finds a match if either term exists. This is equivalent to a union using sets.

To search for an item that contains the terms "recent fires" or fires, use the following query:

1
2
3
{
  "recent fires" OR fires
}

NOT

The NOT operator excludes items that contain the term after NOT. This is equivalent to a difference using sets.

To search for documents that contain California but not Imagery, use the following query:

1
2
3
{
  California NOT Imagery
}

The NOT operator cannot be used with only one term.

-

The -, or the prohibit operator, excludes items that contain the term after the - symbol.

To search for documents that contain California but not Imagery, use the following query:

1
2
3
{
  California -Imagery
}

Special character searches

Search supports querying with special characters. These characters include: + - && || ! ( ) { } [ ] ^ " ~ * ? : \ /

There are two ways to search using special characters:

• Escape special characters using \.
  Use dark colors for code blocksCopy

  1
  q=title:test\:abc
• Enclose query using double quotes "".
  Use dark colors for code blocksCopy

  1
  q=title:"test:abc"

Grouping

You can create subqueries using parentheses to group clauses. This can be useful to control the Boolean logic for a query.

To search for either California or recent and fires, create the following expression:

1
2
3
{
  (California OR recent) AND fires
}

Field grouping

You can group multiple clauses to a single field using parentheses.

To search for a title that contains the phrase "population change" and the word recent, use the following query:

1
2
3
{
  title:("population change" recent)
}

Search for imagery

You can search for different types of imagery based on their image properties using type, servicetags, or typeKeywords.

Examples:

• Find all hosted multidimensional imagery:
  Use dark colors for code blocksCopy

  1
  type: "Image Service" AND servicetags: "hasMultidimensions"
• Find all hosted non-multidimensional imagery:
  Use dark colors for code blocksCopy

  1
  type: "Image Service" AND typekeywords: "Hosted Service" NOT servicetags: "hasMultidimensions"
• Find all imagery that have raster attribute table:
  Use dark colors for code blocksCopy

  1
  type: "Image Service" AND servicetags: "hasRasterAttributeTable"
• Find all hosted imagery that have no raster attribute table:
  Use dark colors for code blocksCopy

  1
  type: "Image Service" AND typekeywords: "Hosted Service" NOT servicetags: "hasRasterAttributeTable"
• Find all imagery that have colormap:
  Use dark colors for code blocksCopy

  1
  type: "Image Service" AND servicetags: "hasColormap"
• Find all imagery that allow analysis:
  Use dark colors for code blocksCopy

  1
  type: "Image Service" AND servicetags: "allowAnalysis"
• Find all imagery based on data type, e.g. all UV or MagDir data:
  Use dark colors for code blocksCopy

  1
  2
  3
  4
  type: "Image Service" AND (servicetags: "DataTypeVector-MagDir" OR servicetags: "DataTypeVector-UV")
  
  // More image data type examples: DataTypeGeneric, DataTypeRGB, DataTypeElevation, DataTypeThematic, DataTypeProcessed,
  DataTypeScientific, DataTypeVector-MagDir, DataTypeVector-UV.
• Find all imagery based on source type:
  Use dark colors for code blocksCopy

  1
  2
  3
  type: "Image Service" AND servicetags: "SourceTypeMosaicDataset"
  
  // More image source type examples: SourceTypeRasterDataset
• Find all imagery based on pixel type:
  Use dark colors for code blocksCopy

  1
  2
  3
  4
  type: "Image Service" AND servicetags: "PixelTypeF32"
  
  // More image pixel type examples: PixelTypeU1, PixelTypeU2, PixelTypeU4, PixelTypeU8, PixelTypeU16, PixelTypeU32,
  PixelTypeS8, PixelTypeS16, PixelTypeS32, PixelTypeF32, PixelTypeF64

Item fields

You can refine your item searches by using specific fields in your search string. These fields include the following:

1
id:4e770315ad9049e7950b552aa1e40869

1
owner:esri

1
created: [1249084800000 TO 1249548000000]

1
modified: [1249084800000 TO 1249548000000]

1
title:"Southern California"

1
type:map

1
typekeywords:tool

1
description:California

1
tags:"San Francisco"

1
snippet:"natural resources"

1
accessinformation:esri

1
group:1652a410f59c4d8f98fb87b25e0a2669

1
numratings:6

1
numcomments:[1 TO 3]

1
avgrating:3.5

1
culture:en-US

1
orgid:5uh3wwYLNzBuU0Ef

1
categories:"Historical Maps"

1
2
3
classification:"Restricted;Proprietary"

classification:(Proprietary)

Group fields

You can filter your searches on groups by using specific fields in your search string. Only public groups or groups to which you have access will be searched. These fields include the following:

1
id:1db70a32f5f84ea9a88f5f460f22557b

1
title:redlands

1
owner:esri

1
description:"street maps"

1
typekeywords:fire

1
snippet:transportation

1
tags:"bike lanes"

1
phone:jsmith33@esri.com

1
created:1247085176000

1
modified:1247085176000

1
orgid:5uh3wwYLNzBuU0Ef