Web service API

How to use PageSeeder's Web service API

start uri index

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

com.pageseeder.search.FolderIndexing

Description

Start folder indexing.

Invoking this service will start an Asynchronous process.

The thread will start the indexing for a single folder. It is similar in all aspects to indexing a group except that only URIs (and their comments and versions) will be considered for indexing.

The indexing will iterate recursively over all the sub-folders and documents within that folder.

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
version The document version if the types include "version"maybestring

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

Note

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

Permission

Only group managers can invoke this service.

If the URI specify does not correspond to a folder, this service will return a permission error.

Response

This service returns the following XML:

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