Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/ExecuteAsyncFullTextQuery

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteAsyncFullTextQuery

 

Starts "asynchronous" full text query. See also operations GetNextFullTextQueryRows and ReleaseFullTextQuery.

 

 

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteAsyncFullTextQuery

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ FullTextQuery

 

mandatory nillable

Sets the full text query.

â–  BlockSize

xs:int

 

Sets the block size for the full text query.

â–  CaseNo

xs:int

 

Sets the case number.

â–¡ Categories

 

mandatory nillable

Sets a list containing the numbers of the categories to search in.

≡ Category

xs:int

list


â–  ContextMaxSizeKB

xs:int

 

Sets the maximum size of the context retrieved by the full text query in kilobytes.

â–  ContextMode

 

mandatory

restriction enum (xs:string)

- FTContextOff (0)

- FTContextOn (1)

- FTContextSize (2)

Sets the context mode for the full text query.

â–  FuzzySearchLevel

xs:int

 

Sets the level for the fuzzy search.

â–  LCID

xs:int

 

Sets the local identifier used for the full text query.

â–  MaxContentChars

xs:int

 

Sets the maximum number of content chars.

â–  MaxRows

xs:int

 

Sets the maximum number of rows the query will retrieve from the server.

â–¡ Search

xs:string

mandatory nillable

Sets the string that is searched for in the full text query.

â–  SearchScope

 

mandatory

restriction enum (xs:string)

- IndexData (0)

- Content (1)

- All (2)

Sets the search scope.

â–  SortOrder

 

mandatory

restriction enum (xs:string)

- ByRelevance (0)

- ByDate (1)

- ByHitCount (2)

Sets the sort order.

â–  UseThesaurus

xs:boolean

 

Sets to true to use thesaurus.

 

 

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/ExecuteAsyncFullTextQueryResponse

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–  QueryId

xs:int

 

Gets the query id.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.