About this resource
Representation of a search index
Properties
| Property | Description | Type |
|---|---|---|
| indexedClassifications | Provides a number of indexed classifications. | int64 |
| indexedRecords | Provides a number of indexed records. | int64 |
| lastChangeDateTime | Provides the last change date and time. | datetime |
| lastChangeId | Provides the last change ID. | int64 |
| lastIndexRebuild | Provides a date and time when the last index built on. | datetime |
| pendingChanges | Provides a number of pending changes. | int32 |
| rebuildRequired | Returns true if the search index needs to be rebuilt. | boolean |
| rebuildScheduled | Returns true if the search is indexing. | boolean |
Relations
Actions
| Method | Action | Description | Response codes | ||||||
|---|---|---|---|---|---|---|---|---|---|
| PUT /searchindex | edit | Manages the search index |
|
||||||
| PUT /uniquekeyindex | edituniquekey | Manages the unique key index |
Examples
Reading the search index state
GET /searchindex
Rebuilding the search index
PUT /searchindex
{
"rebuildScheduled": true
}
"rebuildScheduled" the only property that can be updated using a PUT.
-
When updating to true:
- ignore if already scheduled or running;
- otherwise trigger a rebuild (always shadow in case one exists, otherwise create an initial index).
-
When updating to false:
- if already scheduled or running, cancel rebuild;
- otherwise ignore.