3.1.4.64 StartCrawl

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

 <wsdl:operation name="StartCrawl">
         <wsdl:input message="StartCrawlSoapIn"/>
         <wsdl:output message="StartCrawlSoapOut"/>
 </wsdl:operation>

The protocol client sends a StartCrawlSoapIn request message and the protocol server responds with a StartCrawlSoapOut 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 identifier specified in the contentSource element of the request message, the protocol server MUST throw a SOAP fault message containing a DeletedConcurrencyException.

• If a full crawl is specified in the request message’s type element, the protocol server MUST attempt to begin a full crawl for the specified content source.

• If an incremental crawl is specified in the request message’s type element, and the specified content source has not been crawled before, or the last crawl of the content source was stopped before it finished, the protocol server MUST attempt to start a full crawl for the content source.

• If an incremental crawl is specified in the request message’s type element, and the specified content source has been crawled before, and the last crawl was not stopped before it finished, the protocol server MUST attempt to start an incremental crawl for the content source.

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

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

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