Skip to main content

 Web service API

How to use PageSeeder's Web service API

start group index

/members/{member}/groups/{group}/index/start [POST]

com.pageseeder.search.GroupIndexing

Description

Start group indexing.

Invoking this service starts an Asynchronous process.

Parameters

NameDescriptionRequiredTypeDefault value
typesA comma-separated list of types to index. e.g. comment,documentnoenums
clearWhether to clear the whole index first (only allowed when all types are indexed)nobooleanfalse

The possible types are url, document, comment and version.

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 following XML:

<group-indexing>
  <thread ...> ...
    <indexing>
      <progress current="[current item]"
                total="[total items to index]"/>      
      <!-- for each type specified.. -->
      <type name="[comment|document|version]"
                  [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.

Created on , last edited on