Get QueryAssist
Request
GET <REST API URL>/services/queryAssist?query=string&caret=intParameter | Description |
|---|---|
| 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 Services, the following fields and tuples are supported: applicationName: serviceApplicationName — Services with the given application name baseUrl: value — Services with the given base URL defaultRole: roleName — Services that define the given role groupUriPattern: value — Services with the given group URI pattern has: applicationName — Services with defined applicationName has: vendor — Services with defined vendor has: version — Services with defined version has: homeUrl — Services with defined homeUrl has: baseUrl — Services with defined baseUrl has: userUriPattern — Services with defined user uri has: groupUriPattern — Services with defined group uri has: redirectUri — Services with defined redirect URI has: permission — Services that provide some permissions has: defaultRole — Services that define some default roles has: resource — Services that provide some resources has: license — Services with licenses homeUrl: value — Services with the given home URL id: value — Service with the given ID is: trusted — All trusted services key: value — Service with the given key name: serviceName — Services with the given name permission: permission — Services with the given home URL redirectUri: value — Services with the given redirect URI resource: resource — Service that provides the given resource userUriPattern: value — Services with the given user URI pattern vendor: serviceVendor — Services provided by the given vendor version: serviceVersion — Services with the given version |
| 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, ...],
"suggestions": [querySuggestItem, ...]
}