3.1.4.41 PauseCrawl

  • Article

This operation is used to pause a crawl of a content source of the portal content project.

 <wsdl:operation name="PauseCrawl">
         <wsdl:input message="PauseCrawlSoapIn"/>
         <wsdl:output message="PauseCrawlSoapOut"/>
 </wsdl:operation>

The protocol client sends a PauseCrawlSoapIn request message and the protocol server responds with a PauseCrawlSoapOut response message, as follows:

  • On receipt the protocol server validates the versionIn value from the request message. If it doesn’t match the current configuration version of the crawler application, the protocol server MUST throw a SOAP fault message containing an UpdatedConcurrencyException.

  • If there is no content source with the content source identifier specified by the contentSource element of the request message, the protocol server MUST throw a SOAP fault message containing a DeletedConcurrencyException.

  • The protocol server MUST try to pause the crawl for the content source with the identifier specified in the contentSource element of the request message.

  • If the crawl is in a state where it cannot be paused or is already paused, the protocol server MUST ignore the pause request and return the current crawl status in the PauseCrawlResult element the response message.

  • On success, the protocol server MUST return the current crawl status in the PauseCrawlResult element the response message.

  • On error, the protocol server MUST throw a SOAP fault message.