Get QueryAssist

Request

GET <REST API URL>/roles/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 Roles: has: permission — Roles with some permssions id: value — A role with the given id is: team — Roles that are team key: roleKey — A role with the given key name: roleName — A role with the given name permission: permission — Roles that includes the given permission permission(key: permissionKey, service: service) — Roles that includes the given permission permission(service: service) — Roles that have at least one permission from service
`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 Roles:

has: permission — Roles with some permssions

id: value — A role with the given id

is: team — Roles that are team

key: roleKey — A role with the given key

name: roleName — A role with the given name

permission: permission — Roles that includes the given permission

permission(key: permissionKey, service: service) — Roles that includes the given permission

permission(service: service) — Roles that have at least one permission from service

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