Waits for the full-text search indexing results.
Base Request
GET /api/query/waitForFullTextSearchIndexing
Query Parameters
| Parameter | Description | Type | Required | Notes |
|---|---|---|---|---|
| refresh | True/false indicator of whether the search results are to be refreshed. | Boolean | Optional | Default is true. |
| timeout | The number of seconds the client waits before retrieving the full-text search results. | integer | Optional | Default is 5. |
| waitForAudit | True/false indicator of whether the request waits for an audit of the full-text search results before retrieving them. | Boolean | Optional | Default is false. |
Headers
| Header Name | Description | Required | Values |
|---|---|---|---|
| Authorization | The access token | Required |
Bearer [access_token]
where [access_token] is a string generated when you complete authentication (see Getting Started) |
| User-Agent | Identity of the client making the request to the server | Required |
[product]/[version]
where [product] is the name of the software you are using to make the request and [version] is the numbered version of the software (for example, MyCompanyProduct/1.0). For information on other types of values commonly included in user-agent request headers, see the User-Agent HTTP header reference section on the Mozilla developer documentation website. |
| HXCS-REPOSITORY | The repository ID | Optional | Any contributed repository name. Default is default. |
| Accept | The format of the data to be returned | Optional | application/vnd.hxcs.v1+json |
Sample Request
GET /api/query/waitForFullTextSearchIndexing?refresh=true&timeout=6&waitForAudit=true
Authorization: Bearer [access_token]
User-Agent: MyCompanyProduct/1.0
HXCS-REPOSITORY: default
Accept: application/vnd.hxcs.v1+json
Sample Response
{}
Status Codes and Errors
The following table lists the returned status codes.
| Code | Description | Notes |
|---|---|---|
| 200 | OK | The client waits for the full-text search indexing results successfully. |
| 401 | Not Authorized | Authentication has failed or was not provided. |
| 403 | Not Allowed | Access permissions are invalid or missing. |