PortalQueryParams

require(["esri/portal/PortalQueryParams"], function(PortalQueryParams) { /* code goes here */ });
Class: esri/portal/PortalQueryParams
Inheritance: PortalQueryParams Accessor
Since: ArcGIS API for JavaScript 4.0

The parameters used to perform a query for Items, Groups, and Users within a Portal.

See also:

Constructors

new PortalQueryParams(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Array<(string|Array<string>)>

An array of categories stored within the item.

more details
more detailsPortalQueryParams
String

The name of the class.

more details
more detailsAccessor
Extent

Only relevant when querying for PortalItems.

more details
more detailsPortalQueryParams
Number

The maximum number of results to be included in the result set response.

more details
more detailsPortalQueryParams
String

The query string used for the search.

more details
more detailsPortalQueryParams
String

A comma-delimited list of fields to sort.

more details
more detailsPortalQueryParams
String

The order in which to sort the results.

more details
more detailsPortalQueryParams
Number

The index of the first entry in the result set response.

more details
more detailsPortalQueryParams

Property Details

categories Array<(string|Array<string>)>
Since: ArcGIS API for JavaScript 4.8

An array of categories stored within the item. Use this property to filter the results from Portal.queryItems() and PortalGroup.queryItems(). It accepts an array of:

  • individual string elements or
  • an array of strings.

The query looks at each element within the array and performs a SQL AND operation 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:

Note: String[] elements are only supported by ArcGIS Online and version 10.6.1 of Portal for ArcGIS Enterprise.

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"]];
declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

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 num property 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

Possible Values:"title"|"uploaded"|"modified"|"username"|"created"|"type"|"owner"|"avg-rating"|"num-ratings"|"num-comments"|"num-views"

See also:
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.

Possible Values:"asc"|"desc"

Default Value:asc
start Number

The index of the first entry in the result set response. The index is 1-based. The start property, along with the num property can be used to paginate the search results.

Default Value:1

Method Overview

Name Return Type Summary Class
PortalQueryParams

Creates a deep clone of the instance of PortalQueryParams that calls this method.

more details
more detailsPortalQueryParams

Method Details

Creates a deep clone of the instance of PortalQueryParams that calls this method.

Returns:
Type Description
PortalQueryParams A clone of the instance that called this method.