Hub 2018.1 Help

Get Mixed QueryAssist

Request

GET <REST API URL>/usergroups/mixed/queryAssist?query=string&caret=int
Parameter Description
query

Optional Lets you 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

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

caret Query parameter of type int.

Response

Response Code Meaning
200 OK Successful request.
400 Bad Request Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains a message that describes the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource was not found.
500 Internal Server Error Failed to process request because of the server error. The response contains a message that describes the error.

Response body

queryAssist

{ "query": string, "caret": int, "styleRanges": [queryStyleRange, ...], "suggestions": [querySuggestItem, ...] }
Last modified: 5 April 2018