Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore Web API > Web API Reference > Operations

ExecuteFullTextQuery

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

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

Searches the contents of Therefore™ documents in one or more categories using information gathered by the Therefore™ indexing service.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ FullTextQuery		mandatory nillable	Sets the full text query.
■ BlockSize	xs:int	optional	Sets the block size for the full text query.
■ CaseNo	xs:int	optional	Sets the case number.
□ Categories		mandatory nillable	Sets a list containing the numbers of the categories to search in.
≡ Category	xs:int	optional unbounded
■ ContextMaxSizeKB	xs:int	optional	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	optional	Sets the level for the fuzzy search.
■ LCID	xs:int	optional	Sets the local identifier used for the full text query.
■ MaxContentChars	xs:int	optional	Sets the maximum number of content chars.
■ MaxRows	xs:int	optional	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	optional	Sets to true to use thesaurus.
□ IncludeIndexData	xs:boolean	optional nillable	Set true if full document index data should be returned in response.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ Results		optional nillable	Gets the full text query result rows.
≡ WSFullTextQueryResultRow		optional unbounded nillable
□ AccessMask		optional nillable	DEPRECATED: Use the RoleAccessMask parameter instead. Gets the access mask of the permissions.
■ Value	xs:unsignedLong	optional	Represents the access mask of the permissions. See also: operation GetPermissionConstants.
■ CategoryNo	xs:int	optional	Gets the number of the category the found document belongs to.
□ Context	xs:string	optional nillable	Gets the context where the search string was found.
■ DocNo	xs:int	optional	Gets the number the document found by the query.
■ DocSize	xs:long	optional	Gets the size of a found document in kilobytes.
□ Extension	xs:string	optional nillable	Gets Extension.
■ HitCount	xs:int	optional	Gets the number of hits.
□ MatchedWords		optional nillable	Gets the list of matched words.
≡ MatchedWord	xs:string	optional unbounded nillable
■ Modified	xs:dateTime	optional	Gets the modified time stamp.
■ Rank	xs:int	optional	Gets the rank of the found document.
■ Relevance	xs:int	optional	Gets the relevance.
■ SubCategoryNo	xs:int	optional	Gets the number of the sub category the found document belongs to.
□ Title	xs:string	optional nillable	Gets the title of the document found in the query.
□ CategoryName	xs:string	optional nillable	Gets the name of the category the found document belongs to.
□ IndexData		optional nillable	Full index data of the document returned by search.
■ CategoryNo	xs:int	mandatory	Gets the number of the category.
□ CtgryName	xs:string	optional nillable	Gets the name of the category.
■ DocNo	xs:int	optional	Gets the document number.
□ IndexDataItems		mandatory nillable	Gets index data items of the document.
≡ WSIndexDataItem		optional unbounded nillable
□ DateIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:dateTime	optional nillable	Gets or sets date value of the field. Date value should be specified without time zone information (in .net DateTimeKind.Uspecified, xml value like 2002-09-24T00:00:00) or as UTC date time (in .net DateTimeKind.Utc, xml value like 2002-09-24T00:00:00Z). This is mandatory, especially when client and server are located in different time zones. See also the DataISO8601Value property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ DataISO8601Value	xs:string	optional nillable	Gets or sets date value of the field in ISO 8601 format (YYYY-MM-DD, example 2017-07-23). See also the DataValue property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ IntIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:int	mandatory nillable	Gets or sets the integer value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ LogicalIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:boolean	mandatory nillable	Gets or sets Boolean value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ MoneyIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:double	optional nillable	Gets or sets the DOUBLE value of the field. Value for the field sould be set either by DataValue or by DecimalDataValue proiperty. DEPRECATED: Use the DecimalDataValue property instead for Therefore™ version 2018 and newer.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ DecimalDataValue	xs:decimal	optional nillable	Gets or sets the DECIMAL value of the field. Value for the field sould be set either by DataValue or by DecimalDataValue proiperty.
□ MultipleKeywordData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue		mandatory nillable	Gets or sets multiple keyword values of the field.
≡ Keyword	xs:string	optional unbounded nillable
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ KeywordNos		optional nillable	Gets or sets multiple keyword numbers of the field.
≡ KeywordNo	xs:int	optional unbounded
□ SingleKeywordData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:string	mandatory nillable	Gets or sets a single keyword value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the field name (when you set it use column name + "_Text" suffix. example: for SK field "Department" use "Department_Text" for it's TEXT value) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ StringIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:string	mandatory nillable	Gets or sets the string value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ TableIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue		mandatory nillable	Gets or sets the table value of the field.
≡ WSTableFieldDataRow		optional unbounded nillable
□ DataRowItems		optional nillable	Gets or sets the items of the row. If it is set to null for update operation - record with given row number (see RowNo parameter) will be deleted.
≡ WSTableFieldDataRowItem		optional unbounded nillable
□ DateIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:dateTime	optional nillable	Gets or sets date value of the field. Date value should be specified without time zone information (in .net DateTimeKind.Uspecified, xml value like 2002-09-24T00:00:00) or as UTC date time (in .net DateTimeKind.Utc, xml value like 2002-09-24T00:00:00Z). This is mandatory, especially when client and server are located in different time zones. See also the DataISO8601Value property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ DataISO8601Value	xs:string	optional nillable	Gets or sets date value of the field in ISO 8601 format (YYYY-MM-DD, example 2017-07-23). See also the DataValue property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ IntIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:int	mandatory nillable	Gets or sets the integer value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ LogicalIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:boolean	mandatory nillable	Gets or sets Boolean value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ MoneyIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:double	optional nillable	Gets or sets the DOUBLE value of the field. Value for the field sould be set either by DataValue or by DecimalDataValue proiperty. DEPRECATED: Use the DecimalDataValue property instead for Therefore™ version 2018 and newer.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ DecimalDataValue	xs:decimal	optional nillable	Gets or sets the DECIMAL value of the field. Value for the field sould be set either by DataValue or by DecimalDataValue proiperty.
□ SingleKeywordData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:string	mandatory nillable	Gets or sets a single keyword value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the field name (when you set it use column name + "_Text" suffix. example: for SK field "Department" use "Department_Text" for it's TEXT value) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ StringIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:string	mandatory nillable	Gets or sets the string value of the field.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ AccessMask		optional nillable	Gets access mask for index data field (column) for connected user.
■ Value	xs:unsignedLong	optional	Represents the access mask of the permissions. See also: operation GetPermissionConstants.
□ DateTimeIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:dateTime	optional nillable	Gets or sets UTC date time value of the field. Date value should be specified as UTC date time. The DataValue property is ignored if the DataISO8601Value property has a value.
□ DataISO8601Value	xs:string	optional nillable	Gets or sets UTC date time value of the field in ISO 8601 format (example 2018-05-03T14:45:00Z). Date value should be specified as UTC date time. See also the DataValue property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ RowNo	xs:int	optional nillable	Gets or sets the number of the row. While updating the data - null value means creating new row. Starts at 0 (zero).
□ AccessIsEditableRow	xs:boolean	optional nillable	Gets access status for the row for connected user.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
□ AccessMask		optional nillable	Gets access mask for index data field for connected user.
■ Value	xs:unsignedLong	optional	Represents the access mask of the permissions. See also: operation GetPermissionConstants.
□ DateTimeIndexData		optional nillable
■ FieldNo	xs:int	mandatory	Gets or sets the number of the field. Doing request set it to proper field number or to 0 (zero) in order to use the FieldName property instead.
□ DataValue	xs:dateTime	optional nillable	Gets or sets UTC date time value of the field. Date value should be specified as UTC date time. The DataValue property is ignored if the DataISO8601Value property has a value.
□ DataISO8601Value	xs:string	optional nillable	Gets or sets UTC date time value of the field in ISO 8601 format (example 2018-05-03T14:45:00Z). Date value should be specified as UTC date time. See also the DataValue property. The DataValue property is ignored if the DataISO8601Value property has a value.
□ FieldName	xs:string	optional nillable	Gets or sets the name (actualy column name) of the field. Doing request set the FieldNo property to 0 (zero) in order to use specified FieldName.
■ LastChangeTime	xs:dateTime	optional	Gets the timestamp when the index data was changed.
□ Title	xs:string	optional nillable	Gets the title of the document.
■ VersionNo	xs:int	optional	Gets the version number of the document.
□ RoleAccessMask		optional nillable	Gets the role access mask for connected user.
■ Value	xs:unsignedLong	optional	Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.

Legend:

■	Not nillable element.
□	Nillable element.
≡	Unbounded element (List of elements).
Normal	Optional element.
Bold	Mandatory element.