ExecuteAsyncMultiQuery |
Scroll |
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. The default value is 500. |
â–¡ 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 block size for the query. Default value will be used if this parameter is not set. Default block size: 100 rows. |
â–¡ 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 |
|
â– IsPersonalQuery |
xs:boolean |
|
Indicates if query is a personal query. |
â–¡ Name |
xs:string |
nillable |
A query name used to display query in UI. |
â– QueryNo |
xs:int |
|
Query number of the query. |
â–¡ MaxRows |
xs:int |
nillable |
Sets the maximum number of rows the query will retrieve from the server. The default value is 500. |
â–¡ 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: 100 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 tab order position of this field. |
â– 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. |
â–¡ Condition |
xs:string |
nillable |
Gets the condition for conditional visibility of the tab. |
â–¡ 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. |
â– ConditionMode |
|
restriction enum (xs:string) - Formatting (0) - Disabled (1) - Mandatory (2) |
Gets the condition mode for conditional formatting. |
â– IsDependencyTrigger |
xs:boolean |
|
Returns true if data change in this field can trigger value change in other fields in the index data. (Due to prim-dep-group membership / calculated field / ref.tab. filtering field.) |
â–¡ DocTitleConfig |
|
nillable |
Title configurations for all the different use cases. |
≡ WSDocTitleConfigEntry |
|
list nillable |
|
â–¡ FieldNos |
|
nillable |
Fields included in the title, ordered. |
≡ int |
xs:int |
list |
|
â– HideCtgryName |
xs:boolean |
|
True means that category name doesn't appear in the title. |
â– MaxLength |
xs:int |
|
When the title length exceeds this length then it will be cut off to this length. |
â– ShowFieldName |
xs:boolean |
|
True means that field names appears in the title. |
â– TitleType |
|
restriction enum (xs:string) - Undef (0) - Default (1) - TitleBar (2) - DocumentName (3) - Mobile (4) - Teams (5) - Export (6) - Send (7) - TreeView (8) - RecycleBin (9) - Logs (10) |
The use case of the title. |
â– HasRemainingRows |
xs:boolean |
|
Displays whether there are any results remaining or not. |
Legend:
â– |
Not nillable element. |
â–¡ |
Nillable element. |
≡ |
List of elements. |
Bold |
Mandatory element. |