Web service API

How to use PageSeeder's Web service API

member server index start

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

com.pageseeder.search.ServerIndexing

Description

Start server indexing.

Start the indexing for a list of groups. Here is a definition of current, old and obsolete groups:

  • current – groups with the current index version
  • old – groups with an index version that is less than current but higher than current major version
  • obsolete – groups with an index version that is less than current major version

Parameters

NameDescriptionRequiredTypeDefault value
prefixA project name to index, all groups under this project will be indexed, if not there, all server groups are indexed.maybestring
includeA comma-separated list of group types to index (supported values are "current", "old" and "obsolete", default is "current,old,obsolete")nostring

Permission

Permissions requirements to be updated.

Response

Undocumented XML response

Error Handling

No specific errors expected for this generator.

Created on , last edited on