Skip to main content

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

The thread starts 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) are considered for indexing.

The indexing iterates 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 versionmaybestring

The possible types are 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.

If the URI specified does not correspond to a folder, this service returns 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