start server index
/members/{member}/index/start [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.9000 | 6.0000 | xml, json |
Description
Start server indexing. Invoking this service starts an Asynchronous process.
Start the indexing for specified objects:
personal– all user’s personal groupsprojects– all groups under specified projectsurls– all URLs on the serverhelp– all built-in help documents (custom help is included underprojects)
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| prefix | A project name to index, all groups under this project are indexed, if not specified groups under all server projects are indexed (requires projects in include parameter) | no | string | |
| include | A comma-separated list of group types to index (supported values are personal, projects, urls, help) | no | string |
|
Permission
This service requires administrator.
Response
This service returns the following XML:
<server-indexing>
<thread ...> ...
<indexing>
<groups group=[group name]
current=[current group no.]
total=[total groups to index]/>
<progress current="[current item no.]"
total="[total items to index]"/>
<!-- for each type specified.. -->
<type name="[comment|document|version]"/>
...
</indexing>
</thread>
</server-indexing>Error Handling
No specific errors expected for this service.