Hub 2017.3 Help

Get QueryAssist


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

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

id: value — Settings with the given ID

type: license — Get license settings

type: public — Get public settings

type: internal — Get internal settings

type: smtp — Get smtp settings

type: jabber — Get jabber settings

type: backup — Get jabber settings

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.

Response body


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