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	nillable	Sets the string to search in the query.
□ Queries		mandatory nillable	Sets list of queries.
≡ QueryBasicObject		list nillable
□ CaseDefinitionNo	xs:int	nillable	Sets the number of the case definition to search in the case definition.
□ CategoryNo	xs:int	nillable	Sets the number of the category to search in the category.
□ Conditions		nillable	Sets the conditions list for the query.
≡ WSCondition		list 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		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	nillable	Looks up the specified column name and uses the field number for a query for an external data table.
□ FileByFieldNo	xs:int	nillable	Sets the field number for a query for an external data table.
■ MaxRows	xs:int		Sets the maximum number of rows the query will retrieve from the server.
□ Mode		nillable restriction enum (xs:string) - NormalQuery (0) - FileQuery (1) - WorkflowQuery (4) - CaseQuery (5)	Sets the mode of the query.
□ OrderByFieldsNoOrNames		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	list nillable
■ RowBlockSize	xs:int		Sets the rows block size for the query. The default value is 100.
□ SelectedFieldsNoOrNames		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	list nillable
□ GroupByFieldsNoOrNames		nillable	Contains list of field numbers, that the query should be grouped by
≡ FieldNoOrName	xs:string	list nillable
□ MaxRows	xs:int	nillable	Sets the maximum number of rows the query will retrieve from the server.
□ Mode		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	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		Gets the query id.
□ QueryResults		nillable	Gets the result of the query.
≡ WSQueryResult		list nillable
■ CaseDefinitionNo	xs:int		Gets the number of the case definition containing the found elements.
■ CategoryNo	xs:int		Gets the number of the category containing the found elements.
■ ProcessNo	xs:int		Gets the number of the process that the found elements belong to (if any).
□ ResultRows		nillable	Gets the query result rows.
≡ WSQueryResultRow		list nillable
□ AccessMask		nillable	DEPRECATED: Use the RoleAccessMask property instead. Gets the access mask of the permissions.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetPermissionConstants.
■ DocNo	xs:int		Gets the document number of the associated Therefore™ document.
□ IndexValues		nillable	List of index values presented as a string list.
≡ IndexValue	xs:string	list nillable
■ Size	xs:long		Gets the size of the associated Therefore™ document.
■ VersionNo	xs:int		Gets the version number of the document.
■ Status		restriction enum (xs:string) - DocStatusCheckedIn (0) - DocStatusCheckedOutByUser (1) - DocStatusCheckedOut (2) - CaseStatusNormal (10) - CaseStatusClosed (11) - Reserved1 (9101) - Reserved2 (9102)	Gets status of the document.
□ RoleAccessMask		nillable	Gets the access mask of the permissions.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.
□ Columns		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		list nillable
■ BelongsTo	xs:int		Gets the field number of the TheCategoryField this field belongs to (set for dependent fields only).
■ BelongsToTable	xs:int		Gets the field number of the TheCategoryField this field belongs to (is set for fields which belong to table only).
□ Caption	xs:string	nillable	Gets the caption of the field.
■ CaseSensitive	xs:boolean		Gets information if the field is case sensitive.
□ ColName	xs:string	nillable	Gets the column name of the field in the database.
■ CounterMode		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	nillable	Gets the default value for this field.
■ DependencyMode		restriction enum (xs:string) - Referenced (0) - SynchronizedRedundant (1) - EditableRedundant (2)	Gets the dependency mode of this field.
■ DisplayOrderPos	xs:int		Returns the position of the field inside a table field or the position in the document title.
■ DontLoadValues	xs:boolean		Returns whether choices will be pre-loaded for display (only for keyword and dependent fields).
■ FieldNo	xs:int		Gets the field number of this field.
■ FieldType		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	nillable	Gets the column name of the referenced column in a foreign table (set for dependent fields only).
■ Guid	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 GUID of this field.
■ Height	xs:int		Gets the height of this field in the category dialog.
□ IndexDataFieldName	xs:string	nillable	Gets the name of the index data field.
■ IndexType	xs:int		Gets the index type of the field (no / normal / unique).
■ IsForeignDatatype	xs:boolean		Returns whether the field is a foreign data type.
■ IsMultipleKeyword	xs:boolean		Returns whether the field is a multiple keyword.
■ IsSingleKeyword	xs:boolean		Returns whether the field is a single keyword.
■ KeepRedundant	xs:boolean		Gets information if values from a foreign data type should be copied to the TWC table and kept there redundant.
■ Length	xs:int		Gets the length of the field.
■ Mandatory	xs:boolean		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		Gets the horizontal position of this field in the category dialog in pixels.
■ PosY	xs:int		Gets the vertical position of this field in the category dialog in pixels.
□ RegularExpr	xs:string	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		Gets the tabulator position of this field in the category dialog in pixels.
■ TypeGroup		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	nillable	Gets the type index column of the field. Additional information for user defined data type (TypeNo > 6).
□ TypeMultiInner	xs:string	nillable	Gets the type multi inner of the field. Additional information for user defined data type (TypeNo > 6).
□ TypeMultiJoin	xs:string	nillable	Gets the type multi join of the field. Additional information for user defined data type (TypeNo > 6).
□ TypeMultiOuter	xs:string	nillable	Gets the type multi outer of the field. Additional information for user defined data type (TypeNo > 6).
■ TypeNo	xs:int		Gets the type number of this field.
□ TypeTableName	xs:string	nillable	Gets the type table name of the field. Additional information for user defined data type (TypeNo > 6).
■ Visible	xs:boolean		Returns whether or not the field is visible in the category dialog.
■ Width	xs:int		Gets the width of this field in the category dialog.
□ WorkflowField	xs:string	nillable	Gets the name of the corresponding Microsoft® Exchange form field (if Microsoft® Exchange workflow is enabled for the category).
■ SelectFromDropDownBox	xs:boolean		Returns whether dropdown box should be used to select value.
□ DisplayProperties		nillable	Gets display properties of this field.
■ BackgroundColor	xs:int		Gets the background color of the field.
■ Bold	xs:boolean		True if the font is formatted as bold.
□ FaceName	xs:string	nillable	Gets the face name.
■ FontSize	xs:int		Gets the font size of the field.
■ HorizontalAlignment		restriction enum (xs:string) - Left (0) - CenterH (1) - Right (2)	Gets the horizontal alignment of the text.
■ Italic	xs:boolean		True if the font is formatted as italic.
■ Padding	xs:int		Gets a value that indicates the thickness of padding space.
■ TextColor	xs:int		Gets the text color of the field.
■ Underlined	xs:boolean		True if the font is formatted as underlined.
■ VerticalAlignment		restriction enum (xs:string) - Top (0) - CenterV (4) - Bottom (8)	Gets the vertical alignment of the text.
□ ImageDocNo	xs:int	nillable	Gets the number of the document image.
■ IsImageFieldType	xs:boolean		Returns whether the field is an image field.
■ IsTabControlFieldType	xs:boolean		Returns whether the field is a tab control field.
■ ParentFieldNo	xs:int		Gets number of parent field (tab control or table field).
■ ShowInTabNo	xs:int		Gets number of tab where current field is shown or 0 (zero).
□ Tabs		nillable	Gets list of tabs if current field is a tab control field.
≡ WSTabInfo		list nillable
■ BackgroundColor	xs:int		Gets background color.
□ Caption	xs:string	nillable	Gets the caption of the tab.
■ Position	xs:int		Gets the position of the tab in the tab control.
■ TabColor	xs:int		Gets the tab color of the tab.
■ TabNo	xs:int		Gets the number of this tab.
■ TextColor	xs:int		Gets the text color of the tab.
■ Visible	xs:boolean		Gets whether or not the tab is visible in the category dialog.
□ AccessMask		nillable	DEPRECATED: Use the RoleAccessMask property instead. Gets access mask for the field for connected user.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetPermissionConstants.
■ IsAutoAppendField	xs:boolean		Gets access mask for the field for connected user.
■ IsDateTimeFieldType	xs:boolean		Returns whether the field is a Therefore™ Timestamp (date/time) field.
■ Scale	xs:int		Returns scale for decimal field.
□ RegExSample	xs:string	nillable	Example of a valid data string for the field.
□ FieldID	xs:string	nillable	Gets the field ID of the field.
□ Condition	xs:string	nillable	Gets condition for conditional formating for the field.
□ ConditionalFormatting		nillable	Gets conditional formating specification. Returns null if the condition is empty.
□ BackgroundColorBGR	xs:int	nillable	Gets background color for the field (in BGR color space) or null.
□ BackgroundColorRGB	xs:int	nillable	Gets background color for the field (in RGB color space) or null.
■ FieldNo	xs:int		Gets number of the field.
□ TextColorBGR	xs:int	nillable	Gets text color for the field (in BGR color space) or null.
□ TextColorRGB	xs:int	nillable	Gets text color for the field (in RGB color space) or null.
□ Formula	xs:string	nillable	Gets formula for calculated field.
■ IsCalculationTrigger	xs:boolean		Returns true if data change on the field can trigger a calculation on the index data.
■ IsFormattingTrigger	xs:boolean		Returns true if data change on the field can trigger formatting update for the index data.
□ RoleAccessMask		nillable	Gets role access mask for the field for connected user.
■ Value	xs:unsignedLong		Represents the access mask of the permissions. See also: operation GetRolePermissionConstants.
■ SortDescending	xs:boolean		Gets sort order of the field.
□ Filter		nillable	Gets list of referenced table filters. It can only be set on a primary field. For any other field type the property will be null.
≡ WSFieldFilter		list nillable
□ Condition	xs:string	nillable	Gets or sets filter condition for given field. It contains either an index FieldID (not FieldNo) or a fixed value. Its value is treated as a fixed value when it contains only [0-9] characters or when it is between double quotation marks ("). This index field value or the fixed value will be compared to the value in the ReferencedTableColumn and the non-matching rows will be filtered out.
□ ReferencedTableColumn	xs:string	nillable	Gets or sets referenced table column(field) for the condition. It contains FieldID (not FieldNo) of the referenced index field.
■ HasRemainingRows	xs:boolean		Displays whether there are any results remaining or not.

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.