Skip to main content

 Services

Web services from /about to /webhooks

start server index

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

com.pageseeder.search.ServerIndexing

Description

Start server indexing. Invoking this service starts an Asynchronous process.

Start the indexing for specified objects:

  • personal– all user’s personal groups
  • projects – all groups under specified projects
  • urls – all URLs on the server
  • help – all built-in help documents (custom help is included under projects)

Parameters

NameDescriptionRequiredTypeDefault value
prefixA project name to index, all groups under this project are indexed, if not specified groups under all server projects are indexed (requires projects in include parameter)nostring
includeA comma-separated list of group types to index (supported values are personal, projects, urls, help)nostring

personal, projects, urls, help

Permission

This service requires administrator.

Response

This service returns the following XML:

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

Error Handling

No specific errors expected for this service.

Created on , last edited on