Hub 2017.4 Help

Get QueryAssist

Request

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

Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for ProjectTeams:

access(project: project, with: role) — Teams that have the given role in the given project

access(project: project, with: permission) — Teams that have the given permission in the given project

access(project: project) — Teams that have some role in the given project

access(with: role) — Teams that have the given role in some projects

access(with: permission) — Teams that have the given permission in some projects

group: group — Teams containing the given group

has: ownRole — Teams with own roles

has: user — Teams with users

has: groups — Teams with included groups

id: value — Project team with the given ID

name: projectName — Team of project with the given name

ownRole: role — Teams that own the given role

project: project — Team of the given project

user: user — Teams where the given user is added explicitly

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 message describing the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource wasn't found.
500 Internal Server Error Failed to process request because of the server error. The response contains message describing the error.

Response body

queryAssist

{ "query": string, "caret": int, "styleRanges": [queryStyleRange, ...], "suggestions": [querySuggestItem, ...] }
Last modified: 7 December 2017