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 will start an Asynchronous process.

The thread will start the indexing for an entire group.

When indexing versions, the parameter version must be specified. For all the documents found, the closest previous version found is indexed.

Parameters

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

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

Note

The 'types' parameter isn't required but, if it isn't specified, there will be nothing to index.

Permission

Only group managers 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