Get QueryAssist

Request

GET <REST API URL>/projectroles/queryAssist?query=string&caret=int

Parameter Description

Parameter	Description
`query`	Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for ProjectRoles: group: group — Project roles owned by the given group id: value — A project role with the given id is: team — Project roles with team roles permission: permission — Project roles granted with the given permission project: project — Project roles granted for the given project role: role — Project roles granted with the given role service: service — Project roles owned by the given service user: user — Project roles owned by the given user
`caret`	Query parameter of type int.

query

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

group: group — Project roles owned by the given group

id: value — A project role with the given id

is: team — Project roles with team roles

permission: permission — Project roles granted with the given permission

project: project — Project roles granted for the given project

role: role — Project roles granted with the given role

service: service — Project roles owned by the given service

user: user — Project roles owned by the given user

caret Query parameter of type int.

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.

    {      "query": string,       "caret": int,       "styleRanges": [queryStyleRange, ...],       "suggestions": [querySuggestItem, ...]    }

Last modified: 19 July 2017