ExecuteFullTextQuery |
Scroll |
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 |
|
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. |
â–¡ IncludeIndexData |
xs:boolean |
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 |
|
nillable |
Gets the full text query result rows. |
≡ WSFullTextQueryResultRow |
|
list nillable |
|
â–¡ AccessMask |
|
nillable |
DEPRECATED: Use the RoleAccessMask parameter instead. Gets the access mask of the permissions. |
â– Value |
xs:unsignedLong |
|
Represents the access mask of the permissions. See also: operation GetPermissionConstants. |
â– CategoryNo |
xs:int |
|
Gets the number of the category the found document belongs to. |
â–¡ Context |
xs:string |
nillable |
Gets the context where the search string was found. |
â– DocNo |
xs:int |
|
Gets the number the document found by the query. |
â– DocSize |
xs:long |
|
Gets the size of a found document in kilobytes. |
â–¡ Extension |
xs:string |
nillable |
Gets Extension. |
â– HitCount |
xs:int |
|
Gets the number of hits. |
â–¡ MatchedWords |
|
nillable |
Gets the list of matched words. |
≡ MatchedWord |
xs:string |
list nillable |
|
â– Modified |
xs:dateTime |
|
Gets the modified time stamp. |
â– Rank |
xs:int |
|
Gets the rank of the found document. |
â– Relevance |
xs:int |
|
Gets the relevance. |
â– SubCategoryNo |
xs:int |
|
Gets the number of the sub category the found document belongs to. |
â–¡ Title |
xs:string |
nillable |
Gets the title of the document found in the query. |
â–¡ CategoryName |
xs:string |
nillable |
Gets the name of the category the found document belongs to. |
â–¡ IndexData |
|
nillable |
Full index data of the document returned by search. |
â– CategoryNo |
xs:int |
mandatory |
Gets the number of the category. |
â–¡ CtgryName |
xs:string |
nillable |
Gets the name of the category. |
â– DocNo |
xs:int |
|
Gets the document number. |
â–¡ IndexDataItems |
|
mandatory nillable |
Gets index data items of the document. |
≡ WSIndexDataItem |
|
list nillable |
|
â–¡ DateIndexData |
|
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 |
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 |
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 |
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 |
|
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 |
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 |
|
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 |
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 |
|
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 |
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 |
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 |
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 |
|
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 |
list nillable |
|
â–¡ FieldName |
xs:string |
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 |
|
nillable |
Gets or sets multiple keyword numbers of the field. |
≡ KeywordNo |
xs:int |
list |
|
â–¡ SingleKeywordData |
|
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 |
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 |
|
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 |
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 |
|
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 |
|
list nillable |
|
â–¡ DataRowItems |
|
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 |
|
list nillable |
|
â–¡ DateIndexData |
|
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 |
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 |
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 |
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 |
|
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 |
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 |
|
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 |
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 |
|
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 |
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 |
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 |
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 |
|
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 |
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 |
|
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 |
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 |
|
nillable |
Gets access mask for index data field (column) for connected user. |
â– Value |
xs:unsignedLong |
|
Represents the access mask of the permissions. See also: operation GetPermissionConstants. |
â–¡ DateTimeIndexData |
|
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 |
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 |
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 |
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. |
â–¡ RoleAccessMask |
|
nillable |
Gets the role access mask for index data field(column) for connected user. |
â– Value |
xs:unsignedLong |
|
Represents the access mask of the permissions. See also: operation GetRolePermissionConstants. |
â–¡ RowNo |
xs:int |
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 |
nillable |
Gets access status for the row for connected user. |
â–¡ FieldName |
xs:string |
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 |
|
nillable |
Gets access mask for index data field for connected user. |
â– Value |
xs:unsignedLong |
|
Represents the access mask of the permissions. See also: operation GetPermissionConstants. |
â–¡ DateTimeIndexData |
|
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 |
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 |
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 |
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. |
â–¡ RoleAccessMask |
|
nillable |
Gets the role access mask for index data field for connected user. |
â– Value |
xs:unsignedLong |
|
Represents the access mask of the permissions. See also: operation GetRolePermissionConstants. |
â– LastChangeTime |
xs:dateTime |
|
Gets the timestamp when the index data was changed. |
â–¡ Title |
xs:string |
nillable |
Gets the title of the document. |
â– VersionNo |
xs:int |
|
Gets the version number of the document. |
â– CaseDefinitionNo |
xs:int |
|
Gets the number of the case definition. |
â– CaseNo |
xs:int |
|
Gets the number of the case. |
â–¡ LastChangeTimeISO8601 |
xs:string |
nillable |
Gets the timestamp (in ISO 8601 format, UTC) when the index data was changed. |
â–¡ RoleAccessMask |
|
nillable |
Gets the role access mask for connected user. |
â– Value |
xs:unsignedLong |
|
Represents the access mask of the permissions. See also: operation GetRolePermissionConstants. |
â–¡ ModifiedISO8601 |
xs:string |
nillable |
Gets the modified time stamp (in ISO 8601 format, UTC). |
Legend:
â– |
Not nillable element. |
â–¡ |
Nillable element. |
≡ |
List of elements. |
Bold |
Mandatory element. |