Get QueryAssist

Request

GET <REST API URL>/resources/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 Resources: has: type — Resources with some type has: homeUrl — Resources with some homeURL homeUrl: value — A resource with the given homeURL id: value — A resource with the given id key: resourceKey — A resource with the given key name: resourceName — A resource with the given name project: project — Resources in the griven project service: service — Resources held by the given service type: resourceType — Resources of the given type
`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 Resources:

has: type — Resources with some type

has: homeUrl — Resources with some homeURL

homeUrl: value — A resource with the given homeURL

id: value — A resource with the given id

key: resourceKey — A resource with the given key

name: resourceName — A resource with the given name

project: project — Resources in the griven project

service: service — Resources held by the given service

type: resourceType — Resources of the given type

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: 6 April 2017