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

ExecuteAsyncMultiQuery

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

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

Starts 'asynchronous' multi query. See also: operations GetNextMultiQueryRows and ReleaseMultiQuery. Multi query is used for searching and finding information across multiple categories with potentially different field selections, orders and conditions. FullText search string is one for all queries.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ FullText	xs:string	optional nillable	Sets the string to search in the query.
□ Queries		mandatory nillable	Sets list of queries.
≡ QueryBasicObject		optional unbounded nillable
□ CaseDefinitionNo	xs:int	optional nillable	Sets the number of the case definition to search in the case definition.
□ CategoryNo	xs:int	optional nillable	Sets the number of the category to search in the category.
□ Conditions		optional nillable	Sets the conditions list for the query.
≡ WSCondition		optional unbounded nillable
□ Condition	xs:string	mandatory nillable	Sets or gets condition.
□ FieldNoOrName	xs:string	mandatory nillable	Sets or gets number or name of the field. When returned from the server it contains field number. When returned from the server it contains field number.
■ TimeZone		optional restriction enum (xs:string) - UTC (0) - ServerLocal (1)	Sets or gets the time zone used in the condition for date/time values. The 'ServerLocal' option means that timezone from HTTP header 'The-Timezone-IANA' or 'The-Timezone-Microsoft' will be used if defined, otherwise the server local time zone will be used. If not set the UTC time zone will be used.
□ FileByColName	xs:string	optional nillable	Looks up the specified column name and uses the field number for a query for an external data table.
□ FileByFieldNo	xs:int	optional nillable	Sets the field number for a query for an external data table.
■ MaxRows	xs:int	optional	Sets the maximum number of rows the query will retrieve from the server.
□ Mode		optional nillable restriction enum (xs:string) - NormalQuery (0) - FileQuery (1) - WorkflowQuery (4) - CaseQuery (5)	Sets the mode of the query.
□ OrderByFieldsNoOrNames		optional nillable	Orders result rows by field numbers or names. When returned from the server it contains field numbers. When returned from the server it contains field numbers.
≡ FieldNoOrName	xs:string	optional unbounded nillable
■ RowBlockSize	xs:int	optional	Sets the rows block size for the query. The default value is 100.
□ SelectedFieldsNoOrNames		optional nillable	Sets the list of field numbers or names to get these fields as a result. Set to null to get all the fields. Empty list means no fields will be returnded in response. When returned from the server it contains field numbers.
≡ FieldNoOrName	xs:string	optional unbounded nillable
□ GroupByFieldsNoOrNames		optional nillable	Contains list of field numbers, that the query should be grouped by
≡ FieldNoOrName	xs:string	optional unbounded nillable
□ MaxRows	xs:int	optional nillable	Sets the maximum number of rows the query will retrieve from the server.
□ Mode		optional nillable restriction enum (xs:string) - NormalQuery (0) - FileQuery (1) - WorkflowQuery (4) - CaseQuery (5)	Sets the mode for the query. The default value is NormalQuery.
□ RowBlockSize	xs:int	optional nillable	Sets the block size for the query. Default value will be used if this parameter is not set. Default block size: 500 rows.

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ QueryId	xs:int	optional	Gets the query id.
□ QueryResults		optional nillable	Gets the result of the query.
≡ WSQueryResult		optional unbounded nillable
■ CaseDefinitionNo	xs:int	optional	Gets the number of the case definition containing the found elements.
■ CategoryNo	xs:int	optional	Gets the number of the category containing the found elements.
■ ProcessNo	xs:int	optional	Gets the number of the process that the found elements belong to (if any).
□ ResultRows		optional nillable	Gets the query result rows.
≡ WSQueryResultRow		optional unbounded nillable
□ AccessMask		optional nillable	DEPRECATED: Use the RoleAccessMask property instead. Gets the access mask of the permissions.
■ Value	xs:unsignedLong	optional	Represents the access mask of the permissions. See also: operation GetPermissionConstants.
■ DocNo	xs:int	optional	Gets the document number of the associated Therefore™ document.
□ IndexValues		optional nillable	List of index values presented as a string list.
≡ IndexValue	xs:string	optional unbounded nillable
■ Size	xs:long	optional	Gets the size of the associated Therefore™ document.
■ VersionNo	xs:int	optional	Gets the version number of the document.
■ Status		optional restriction enum (xs:string) - DocStatusCheckedIn (0) - DocStatusCheckedOutByUser (1) - DocStatusCheckedOut (2) - CaseStatusNormal (10) - CaseStatusClosed (11) - Reserved1 (9101) - Reserved2 (9102)	Gets status of the document.
□ RoleAccessMask		optional nillable	Gets the access mask of the permissions.
■ Value	xs:unsignedLong	optional	Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.
□ Columns		optional nillable	List of fields in the result. For the ExecuteSimpleQuery operation value is null. If you need list of Columns use the ExecuteSingleQuery operation instead.
≡ WSCategoryField		optional unbounded nillable
■ BelongsTo	xs:int	optional	Gets the field number of the TheCategoryField this field belongs to (set for dependent fields only).
■ BelongsToTable	xs:int	optional	Gets the field number of the TheCategoryField this field belongs to (is set for fields which belong to table only).
□ Caption	xs:string	optional nillable	Gets the caption of the field.
■ CaseSensitive	xs:boolean	optional	Gets information if the field is case sensitive.
□ ColName	xs:string	optional nillable	Gets the column name of the field in the database.
■ CounterMode		optional restriction enum (xs:string) - Undefined (0) - ClientCounter (1) - ServerCounter (2)	Gets the counter mode of the TheCategoryField if it is a counter field.
□ DefaultVal	xs:string	optional nillable	Gets the default value for this field.
■ DependencyMode		optional restriction enum (xs:string) - Referenced (0) - SynchronizedRedundant (1) - EditableRedundant (2)	Gets the dependency mode of this field.
■ DisplayOrderPos	xs:int	optional	Returns the position of the field inside a table field or the position in the document title.
■ DontLoadValues	xs:boolean	optional	Returns whether choices will be pre-loaded for display (only for keyword and dependent fields).
■ FieldNo	xs:int	optional	Gets the field number of this field.
■ FieldType		optional restriction enum (xs:string) - StringField (1) - IntField (2) - DateField (3) - LabelField (4) - MoneyField (5) - LogicalField (6) - NumericCounter (8) - TextCounter (9) - TableField (10) - CustomField (99)	Gets the category field type. NOTE: if FieldType value is 'CustomField' check values of IsImageFieldType and IsTabControlFieldType properties to find out type of the field.
□ ForeignCol	xs:string	optional nillable	Gets the column name of the referenced column in a foreign table (set for dependent fields only).
■ Guid	xs:string	optional GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}	Gets GUID of this field.
■ Height	xs:int	optional	Gets the height of this field in the category dialog.
□ IndexDataFieldName	xs:string	optional nillable	Gets the name of the index data field.
■ IndexType	xs:int	optional	Gets the index type of the field (no / normal / unique).
■ IsForeignDatatype	xs:boolean	optional	Returns whether the field is a foreign data type.
■ IsMultipleKeyword	xs:boolean	optional	Returns whether the field is a multiple keyword.
■ IsSingleKeyword	xs:boolean	optional	Returns whether the field is a single keyword.
■ KeepRedundant	xs:boolean	optional	Gets information if values from a foreign data type should be copied to the TWC table and kept there redundant.
■ Length	xs:int	optional	Gets the length of the field.
■ Mandatory	xs:boolean	optional	Returns whether or not the field is mandatory and must be filled out before archiving a document or changing the index data.
■ PosX	xs:int	optional	Gets the horizontal position of this field in the category dialog in pixels.
■ PosY	xs:int	optional	Gets the vertical position of this field in the category dialog in pixels.
□ RegularExpr	xs:string	optional nillable	Gets the regular expression if one has been defined in Solution Designer. Defining regular expressions via the API is not possible.
■ TabOrderPos	xs:int	optional	Gets the tabulator position of this field in the category dialog in pixels.
■ TypeGroup		optional restriction enum (xs:string) - StandardTypeGroup (1) - KeywordTypeGroup (2) - UserInt (3) - UserTextAnsi (4) - UserDate (5) - UserFloat (6) - UserTextUnicode (7) - CaseDefinitionTypeGroup (8)	Gets the type group of the field.
□ TypeIndexColumn	xs:string	optional nillable	Gets the type index column of the field. Additional information for user defined data type (TypeNo > 6).
□ TypeMultiInner	xs:string	optional nillable	Gets the type multi inner of the field. Additional information for user defined data type (TypeNo > 6).
□ TypeMultiJoin	xs:string	optional nillable	Gets the type multi join of the field. Additional information for user defined data type (TypeNo > 6).
□ TypeMultiOuter	xs:string	optional nillable	Gets the type multi outer of the field. Additional information for user defined data type (TypeNo > 6).
■ TypeNo	xs:int	optional	Gets the type number of this field.
□ TypeTableName	xs:string	optional nillable	Gets the type table name of the field. Additional information for user defined data type (TypeNo > 6).
■ Visible	xs:boolean	optional	Returns whether or not the field is visible in the category dialog.
■ Width	xs:int	optional	Gets the width of this field in the category dialog.
□ WorkflowField	xs:string	optional nillable	Gets the name of the corresponding Microsoft® Exchange form field (if Microsoft® Exchange workflow is enabled for the category).
■ SelectFromDropDownBox	xs:boolean	optional	Returns whether dropdown box should be used to select value.
□ DisplayProperties		optional nillable	Gets display properties of this field.
■ BackgroundColor	xs:int	optional	Gets the background color of the field.
■ Bold	xs:boolean	optional	True if the font is formatted as bold.
□ FaceName	xs:string	optional nillable	Gets the face name.
■ FontSize	xs:int	optional	Gets the font size of the field.
■ HorizontalAlignment		optional restriction enum (xs:string) - Left (0) - CenterH (1) - Right (2)	Gets the horizontal alignment of the text.
■ Italic	xs:boolean	optional	True if the font is formatted as italic.
■ Padding	xs:int	optional	Gets a value that indicates the thickness of padding space.
■ TextColor	xs:int	optional	Gets the text color of the field.
■ Underlined	xs:boolean	optional	True if the font is formatted as underlined.
■ VerticalAlignment		optional restriction enum (xs:string) - Top (0) - CenterV (4) - Bottom (8)	Gets the vertical alignment of the text.
□ ImageDocNo	xs:int	optional nillable	Gets the number of the document image.
■ IsImageFieldType	xs:boolean	optional	Returns whether the field is an image field.
■ IsTabControlFieldType	xs:boolean	optional	Returns whether the field is a tab control field.
■ ParentFieldNo	xs:int	optional	Gets number of parent field (tab control or table field).
■ ShowInTabNo	xs:int	optional	Gets number of tab where current field is shown or 0 (zero).
□ Tabs		optional nillable	Gets list of tabs if current field is a tab control field.
≡ WSTabInfo		optional unbounded nillable
■ BackgroundColor	xs:int	optional	Gets background color.
□ Caption	xs:string	optional nillable	Gets the caption of the tab.
■ Position	xs:int	optional	Gets the position of the tab in the tab control.
■ TabColor	xs:int	optional	Gets the tab color of the tab.
■ TabNo	xs:int	optional	Gets the number of this tab.
■ TextColor	xs:int	optional	Gets the text color of the tab.
■ Visible	xs:boolean	optional	Gets whether or not the tab is visible in the category dialog.
□ AccessMask		optional nillable	DEPRECATED: Use the RoleAccessMask property instead. Gets access mask for the field for connected user.
■ Value	xs:unsignedLong	optional	Represents the access mask of the permissions. See also: operation GetPermissionConstants.
■ IsAutoAppendField	xs:boolean	optional	Gets access mask for the field for connected user.
■ IsDateTimeFieldType	xs:boolean	optional	Returns whether the field is a Therefore™ Timestamp (date/time) field.
■ Scale	xs:int	optional	Returns scale for decimal field.
□ RegExSample	xs:string	optional nillable	Example of a valid data string for the field.
□ FieldID	xs:string	optional nillable	Gets the field ID of the field.
□ Condition	xs:string	optional nillable	Gets condition for conditional formating for the field.
□ ConditionalFormatting		optional nillable	Gets conditional formating specification. Returns null if the condition is empty.
□ BackgroundColorBGR	xs:int	optional nillable	Gets background color for the field (in BGR color space) or null.
□ BackgroundColorRGB	xs:int	optional nillable	Gets background color for the field (in RGB color space) or null.
■ FieldNo	xs:int	optional	Gets number of the field.
□ TextColorBGR	xs:int	optional nillable	Gets text color for the field (in BGR color space) or null.
□ TextColorRGB	xs:int	optional nillable	Gets text color for the field (in RGB color space) or null.
□ Formula	xs:string	optional nillable	Gets formula for calculated field.
■ IsCalculationTrigger	xs:boolean	optional	Returns true if data change on the field can trigger a calculation on the index data.
■ IsFormattingTrigger	xs:boolean	optional	Returns true if data change on the field can trigger formatting update for the index data.
□ RoleAccessMask		optional nillable	Gets role access mask for the field for connected user.
■ Value	xs:unsignedLong	optional	Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.
■ SortDescending	xs:boolean	optional	Gets sort order of the field.
■ HasRemainingRows	xs:boolean	optional	Displays whether there are any results remaining or not.

Legend:

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