start group index
/members/{member}/groups/{group}/index/start [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.0500 | 5.9702 | xml, json |
Description
Start group indexing.
Invoking this service starts an asynchronous process.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| types | A comma-separated list of types to index. e.g. comment,document | no | enums | |
| clear | Whether to clear the whole index first (only allowed when types includes comment,document,url). | no | boolean | false |
The possible types are url, document, comment and version.
The version type is only considered if the indexVersions group property is set to true
The types parameter isn’t required but, if it isn’t specified, there is nothing to index.
Permission
Only group manager can invoke this service.
Response
This service returns the <thread> element that is responsible for indexing.
<group-indexing>
<thread ...> ...
<indexing>
<progress current="[current item]"
total="[total items to index]"/>
<!-- for each type specified.. -->
<type name="[comment|document|version]"/>
...
</indexing>
</thread>
</group-indexing>
Error Handling
No specific errors expected for this service.
After this service is invoked, errors can be found in the indexing logs.