Get QueryAssist
Request
GET <REST API URL>/organizations/queryAssist?query=string&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 Organizations, the following fields and tuples are supported: after: instant — Returns organizations that were created after the specified moment before: instant — Returns organizations that were created before the specified moment has: project — Returns organizations that contain at least one project id: value — Organization with the given ID name: organizationName — Returns organization with the specified name project: project — Returns organizations that immediately contain the given project |
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, ...],
"suggestions": [querySuggestItem, ...]
}