Hub 2018.3 Help

Get QueryAssist

Request

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

Parameter

Description

query

Optional. Lets you specify a search query to filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the Permissions, the following fields and tuples are supported:

entityType: permissionEntityType — Permissions for the given entityType

id: value — Permission with the given ID

is: global — All global permissions

key: permissionKey — Permission with the given key

name: permissionName — Permission with the given name

operation: permissionOperation — Permissions for the given operation

role: role — Permissions of the given role

service: service — Permissions provided by the given service

caret

Query parameter of type int.

Response

Response Code

Meaning

200 OK

Successful request.

400 Bad Request

At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.

403 Forbidden

The requester has no access to the requested resource.

404 Not Found

The requested resource was not found.

500 Internal Server Error

Failed to process request because of the server error. For details, check the error message in the response.

Response body

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