Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

/ admin / groupGetList2

  • Article
  • 2 minutes to read

Description

Invoke this operation to get a list of groups

API Details

  • Status:
  • The required privilege level to invoke this method is user
  • The supported database role for this method is slave
System Rights Database Rights Mail Rights Calendar Rights
--- --- --- ---

Request Parameters

The groupGetList2 method takes the following input parameters.

Note

When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.

Name Type Attributes Description
parent xs:string Optional To return only a list of children, specify the parent.
includeParentInReturn xs:boolean Optional When a parent ID is provided to return a subtree, set this to true if you want to include the parent item specified in the result.
singleLevelOnly xs:boolean Optional Set this to true to return a single level of the tree only based on the parent.
optionsFilter groupOptionsType Optional Specify one or more options to filter return list by. If not specified then all items regardless of options are returned.
type Array<groupType> Optional If not specified then all types of group are returned. If you specify one or more types then only these types of groups are returned.
name xs:string Optional Filter list by group name that starts with specified string
orderBy orderByColumnType Optional Specify a column and direction to order by. If not specified then h_id column and ascending order is assumed.
pageInfo pageInfoType Optional Controls the paging. If element is not specified, paging is disabled

Response Parameters

Name Type Attributes Description
group Array<groupListType> Optional The list of groups.
maxPages numberType Optional A number indicating the maximum number of pages that could be returned.
totalItemCount numberType Optional The total number of items that can be returned by this query.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document