| Authorization token required | true |
| Admin Authorization token required | true |
<ReIndexRequest [action="{"start|status|cancel"}"]> ## ReIndexRequest
<mbox id="{account-id}" [types="{types-comma-sep}"] [ids="{ids-comma-sep}"] /> ## ReindexMailboxInfo
</ReIndexRequest>
elements and attributes you can define within a
<ReIndexRequest> element:
| XPath | Required / Optional | Description | ||||||
| @action | Optional (0 or 1) | Type: String Action to perform
|
||||||
| /mbox | Required (only 1) | Specify reindexing to perform
Note: Only one of {ids-comma-sep} and {types-comma-sep} may be specified. |
||||||
| /mbox@id | Required (only 1) | Type: String Account ID |
||||||
| /mbox@types | Optional (0 or 1) | Type: String Comma separated list of types. Legal values are: conversation|message|contact|appointment|task|note|wiki|document |
||||||
| /mbox@ids | Optional (0 or 1) | Type: String Comma separated list of IDs to re-index |
<ReIndexResponse status="{status}"> ## ReIndexResponse
<progress numSucceeded="{succeeded} (int)" numFailed="{failed} (int)" numRemaining="{remaining} (int)" /> ## ReindexProgressInfo
</ReIndexResponse>
elements and attributes you can define within a
<ReIndexResponse> element:
| XPath | Required / Optional | Description |
| @status | Required (only 1) | Type: String Status - one of started|running|cancelled|idle |
| /progress | Optional (0 or 1) | Information about reindexing progress |
| /progress@numSucceeded | Required (only 1) | Type: int Number of reindexes that succeeded |
| /progress@numFailed | Required (only 1) | Type: int Number of reindexes that failed |
| /progress@numRemaining | Required (only 1) | Type: int Number of reindexes that remaining |