Get QueryAssist

Request

GET <REST API URL>/authmodules/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 AuthModules: has: user — Auth providers that have associated users id: value — Auth provider with the given id is: disabled — All disabled auth providers name: authModuleName — Auth provider with the given name serverUrl: authModuleServerUrl — Auth Modules that have given serverUrl type: authModuleType — Auth providers of the given type user: user — All auth providers that provide user details for the given user
`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 AuthModules:

has: user — Auth providers that have associated users

id: value — Auth provider with the given id

is: disabled — All disabled auth providers

name: authModuleName — Auth provider with the given name

serverUrl: authModuleServerUrl — Auth Modules that have given serverUrl

type: authModuleType — Auth providers of the given type

user: user — All auth providers that provide user details for the given user

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