The parameters used to perform a query for Items, Groups, and Users within a Portal.
- See also:
An array of categories stored within the item.more details
The name of the class.more details
Only relevant when querying for PortalItems.more details
The maximum number of results to be included in the result set response.more details
The query string used for the search.more details
A comma-delimited list of fields to sort.more details
The order in which to sort the results.more details
The index of the first entry in the result set response.more details
- individual string elements or
- an array of strings.
The query looks at each element within the array and performs a SQL
ANDoperation on them. If the element is an array instead of a single string element, the elements within this array are read as
OR. See the snippet below:Example:
// Query items with categories tagged as 'Basemaps' OR 'Imagery' AND 'People' OR 'Environment' // i.e. (Basemaps || Imagery) && (People || Environment) params.categories = [["Basemaps", "Imagery"], ["People", "Environment"]];
The name of the class. The declared class name is formatted as
Only relevant when querying for PortalItems. When specified, restricts the results of the query to the extent defined here.
The spatial reference of the given extent must be WGS84 (wkid 4326) or Web Mercator (wkid 3857).
- num Number
The maximum number of results to be included in the result set response. The maximum value allowed is
100. The start property combined with the
numproperty can be used to paginate the search results.
- Default Value:10
- query String
The query string used for the search. View the ArcGIS REST API Search Reference for details on constructing a valid query.
- See also:
- sortField String
A comma-delimited list of fields to sort. Field names may vary depending on what is being queried. For example, the fields allowed for a user query are much more limited than if performing a basic search query for portal items. A list of possible field names is listed below. These names correspond to either item (search), group, and/or user queries.
Field name Query functionality title search, group uploaded search modified search username user created user, group type search owner search, group avg-rating search num-ratings search num-comments search num-views search
- sortOrder String
The order in which to sort the results.
Possible Value Description asc Sort the results in ascending order. desc Sort the results in descending order.
- Default Value:asc
- start Number
- Default Value:1
Creates a deep clone of the instance of PortalQueryParams that calls this method.more details
API Reference search results