Hub 2.0 Help

Get QueryAssist

Request

GET /permissions/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 permissions:

id: value — A permission with the given key

key: permissionKey — A permission with the given key

name: permissionName — A permission with the given name

entityType: permissionEntityType — Permissions for the given entityType

operation: permissionOperation — Permissions for the given operation

service: service — Permissions provided by the given service

role: role — Persmissions of the given role

is: global — All global permissions

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: 19 September 2016