GET <REST API URL>/usergroups/queryAssist?query=string&caret=int
| || |
Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the UserGroups, the following fields and tuples are supported:
access(project: project, with: role) — Groups that have the given role in the given project
access(project: project, with: permission) — Groups that have the given permission in the given project
access(project: project) — Groups that have some role in the given project
access(with: role) — Groups that have the given role in some projects
access(with: permission) — Groups that have the given permission in some projects
has: ownRole — Groups with own roles
has: user — Groups with users
has: subgroup — Groups with subgroups
has: icon — Groups with an icon
id: value — Group with the given ID
is: allUsers — All user group
is: autoJoin — Groups with enabled auto join
is: required2FA — Groups with required two-factor authentication
name: groupName — Group with the given name
ownRole: role — Groups that have the given role as an own role
parent: group — Subgroups of the given group
project: project — Groups from the given project
subgroup: group — Group that contains the given group as subgroup
team: team — Groups included to the given project team
user: user — Groups that immediately contain the given user
Query parameter of type int.
400 Bad Request
At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.
The requester has no access to the requested resource.
404 Not Found
The requested resource was not found.
500 Internal Server Error
Failed to process request because of the server error. For details, check the error message in the response.