Web service API

How to use PageSeeder's Web service API

get group index status

/groups/{group}/index/status [GET]

com.pageseeder.search.IndexStatus

Description

This service indicates the status of the index of a group.

The purpose of this service is to provide a list of outstanding indexing jobs.

Parameters

No parameters required.

Permission

Undocumented permissions requirements.

Response

When the group exists, the return is:

<indexing>
   <status>
      <index groupid="357"/>
      <jobs total="605"
          document="287"
          folder="98"
          url="22"
          comment="198"/>
   </status>
</indexing>

If the group doesn't exist, the return is:

<indexing>
    <status>
        <jobs total="0"/>
    </status>
</indexing>

Error Handling

No specific errors expected for this service.

Created on , last edited on