|
StartSearchSession |
Scroll |
REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/StartSearchSession
SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/StartSearchSession
Starts a full-text search session for the given document. Use 'GetNextSearchSessionHits' to get found hits. Session expiration time is 30 minutes. During the search session, all document files are first converted to HTML (page by page), and the search term is looked for within these HTML pages. All hits returned by 'GetNextSearchSessionHits' are based on the HTML pages.
Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/StartSearchSession
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â–¡ Keyword |
xs:string |
mandatory nillable |
Sets the search keyword. |
â– DocNo |
xs:int |
mandatory |
Sets the document number to search in. |
â– VersionNo |
xs:int |
mandatory |
Sets the document version to search in. The value must be greater than 0. |
â– MatchCase |
xs:boolean |
|
Set to 'true' if text case should be considered; otherwise, set to 'false'. Default is 'false'. |
â– MatchWholeWord |
xs:boolean |
|
Set to 'true' if text search is limited by a whole word; otherwise, set to 'false'. Default is 'false'. |
â– UseRegularExpression |
xs:boolean |
|
Set to 'true' if a regular expression is used; otherwise, set to 'false'. Default is 'false'. |
â–¡ StartSearchFromStreamNo |
xs:int |
nillable |
Sets the stream number to initiate the full-text search from the specified stream first. If set to 'null', the search will start from the first stream of the document. |
â–¡ RenderWordCommentsAllStreams |
xs:boolean |
nillable |
DEPRECATED: Enables rendering of review comments in Word Office documents for all the streams. The default is False. Can be overridden for any specific stream using the ConversionOptionsByStream parameter. This property overrides the RenderWordComments value in ConversionOptionsByStream when that value is not specified or is set to null. |
â–¡ ConversionOptionsByStream |
|
nillable |
Conversion options that should be applied to the document streams when converting to HTML. It can be specified for specific streams only. If not specified for all or certain streams, the defaults are applied. |
≡ WSConversionOptionsForStream |
|
list nillable |
|
â– StreamNo |
xs:int |
mandatory |
Sets stream number (zero-based). |
â–¡ RenderWordComments |
xs:boolean |
nillable |
DEPRECATED: Enables rendering of review comments in Word documents. Default is False. |
â–¡ Password |
xs:string |
nillable |
Password for encrypted files. |
â– RenderAnnotations |
xs:boolean |
|
Enables rendering of comments / annotations. This applies to multiple document formats like PDF or Office files. |
â–¡ HighlightMaxLength |
xs:int |
nillable |
Sets the maximum text length for the left and right highlights. Default is 40. Max is 80. |
â– IgnoreFileEncryptedErrors |
xs:boolean |
|
Set to true to ignore errors when a password is not provided for an encrypted file (e.g., an encrypted MS Word document). The default setting is false. |
â– RenderAnnotationsAllStreams |
xs:boolean |
|
Enables rendering of comments / annotations. This applies to multiple document formats like PDF or Office files. The default is False. Can be overridden for any specific stream using the ConversionOptionsByStream parameter. This property overrides the RenderAnnotations value in ConversionOptionsByStream when that value is not specified or is set to null. |
Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/StartSearchSessionResponse
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â– SessionId |
xs:string |
GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} |
Gets the ID of the newly started search session. |
Legend:
â– |
Not nillable element. |
â–¡ |
Nillable element. |
≡ |
List of elements. |
Bold |
Mandatory element. |
