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

ExecuteDependentFieldsQuery

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

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

Executes query for dependent field. Returns values from related referenced table.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ CaseDefinitionNo	xs:int	nillable	Sets the number of the case definition for the query. If CaseDefinitionNo is set CategoryNo should not be set.
□ CategoryNo	xs:int	nillable	Sets the category number for the query. If CategoryNo is set CaseDefinitionNo should not be set.
■ FieldNo	xs:int	mandatory	Sets the field number of given category or case definition.
□ IndexDataItems		nillable	Set index data items for filtering. Result rows will be filtered based on the criteria(s) you set here.
≡ 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.
□ MaxRows	xs:int	nillable	Set maximum number of the rows to be returned by the query. Set to '0' or not set it at all if all the rows should be returned.
□ SaveMode	xs:boolean	nillable	Set to 'True' to run query in "SaveMode". Set to 'False' for "SearchMode". In SaveMode query doesn't return deleted keywords.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ QueryResult		nillable	Gets the query result.
□ Columns		nillable	Gets the list of field numbers.
≡ 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.
□ ResultRows		nillable	Gets the query result rows.
≡ WSDependentFieldsQueryResultRow		list nillable
□ FieldValues		nillable	List of index values presented as a string list.
≡ IndexValue	xs:string	list nillable
■ AllRowsReturned	xs:boolean		indicate if all rows were returned or the maximum hitcount was exceeded

Legend:

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