Get QueryAssist
Request
GET <REST API URL>
/authmodules/queryAssist?query=string
&caret=int
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 module with the given ID is: disabled — All disabled auth providers name: authModuleName — Auth module with the given name serverUrl: authModuleServerURL — Auth modules with the given server URL type: authModuleType — Auth modules of the given type user: user — All auth modules that provide user details for the given user |
caret | Query parameter of type int. |
Response
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
queryAssist
{
"query": string,
"caret": int,
"styleRanges": [queryStyleRange
, ...],
"suggestions": [querySuggestItem
, ...]
}
Last modified: 20 November 2017