Group

Get List (POST)

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 (POST) method.

post/group

Request

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

Query parameters

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.

Request body

idstring nullable

Filter by the id of the group.

idInstring[] nullable

Filter by a JSON string array of group ids.

namestring nullable

Filter by the name of the group.

nameLikestring nullable

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

typestring nullable

Filter by the type of the group.

memberstring nullable

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

memberOfTenantstring nullable

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.