Get QueryAssist

Request

GET [[[<REST API URL>|Hub-Rest-Api-URL.html]]]/health/queryAssist?query=string&amp;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 Settings, the following fields and tuples are supported: id: value — Settings with the given ID type: public — Get public settings type: internal — Get internal settings type: smtp — Get smtp settings type: backup — Get backup settings
`caret`	Query parameter of type 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 Settings, the following fields and tuples are supported:

id: value — Settings with the given ID

type: public — Get public settings

type: internal — Get internal settings

type: smtp — Get smtp settings

type: backup — Get backup settings

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|HUB-REST-API_JSON-Scheme.html#queryStyleRange]]], ...], 
    "suggestions": [[[[querySuggestItem|HUB-REST-API_JSON-Scheme.html#querySuggestItem]]], ...]
  }
  

24 March 2025