searchGroups

Function

import { searchGroups } from "@esri/arcgis-rest-portal";
//
searchGroups('water')
  .then(response) // response.total => 355

Search a portal for groups. See the REST Documentation for more information.

searchGroups(search: string | ISearchOptions | SearchQueryBuilder) : Promise<ISearchResult<IGroup>>

Parameters

Parameter	Type	Default	Notes
search Required	string \| ISearchOptions \| SearchQueryBuilder		A string or RequestOptions object to pass through to the endpoint.

A Promise that will resolve with the data from the response.

Promise<ISearchResult<IGroup>>

Property	Type	Notes
nextStart	number
num	number
query	string
results	IItem[] \| IGroup[] \| IUser[] \| IItem \| IGroup \| IUser
start	number
total	number
aggregations Optional	{ counts: Array<{ fieldName: string fieldValues: Array<{ count: number value: any }> }> }	Aggregations will only be present on item searches when `fieldCounts` are requested.
nextPage Optional	function() : Promise<ISearchResult<IItem \| IGroup \| IUser>>