Sign in
Group

Get List

Queries for a list of groups using a list of parameters. The size of the result set can be retrieved by using the Get Group Count method.

get/group

Request

  • Base URL: http://localhost:8080/engine-rest
  • URL: http://localhost:8080/engine-rest/group
  • Auth: HTTP basic

Query parameters

sortBy'id' | 'name' | 'type'

Sort the results lexicographically by a given criterion. Must be used in conjunction with the sortOrder parameter.

sortOrder'asc' | 'desc'

Sort the results in a given order. Values may be asc for ascending order or desc for descending order. Must be used in conjunction with the sortBy parameter.

firstResultinteger

Pagination of results. Specifies the index of the first result to return.

maxResultsinteger

Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left.

idstring

Filter by the id of the group.

idInstring

Filter by a comma seperated list of group ids.

namestring

Filter by the name of the group.

nameLikestring

Filter by the name that the parameter is a substring of.

typestring

Filter by the type of the group.

memberstring

Only retrieve groups where the given user id is a member of.

memberOfTenantstring

Only retrieve groups which are members of the given tenant.

Response

Request successful.

idstring nullable

The id of the group.

namestring nullable

The name of the group.

typestring nullable

The type of the group.

Changes

No recorded changes to this operation across all 1 revision of this API.