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

PreprocessTableRow

Scroll

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

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

Returns index data for given table row (with default values, filled dependent fields).

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ CaseDefinitionNo	xs:int	optional nillable	Set the case definition number. If you set CaseDefinitionNo then the CaseNo, DocNo, and CategoryNo should not be set.
□ CaseNo	xs:int	optional nillable	Set the case number. If you set CaseNo then the CaseDefinitionNo, DocNo, and CategoryNo should not be set.
□ CategoryNo	xs:int	optional nillable	Set the category number. If you set CategoryNo then the DocNo, CaseNo and CaseDefinitionNo should not be set.
□ DocNo	xs:int	optional nillable	Sets the document number. If you set DocNo then the CategoryNo, CaseNo, and CaseDefinitionNo should not be set.
□ FillDependentFields	xs:boolean	optional nillable	Set it to True to fill dependent fields.
□ IsAccessMaskNeeded	xs:boolean	optional nillable	Sets to true if the access mask for given index data fields should be returned in response.
□ ResetToDefaults	xs:boolean	optional nillable	Set it to True to reset index data to default values.
■ TableFieldNo	xs:int	mandatory	Sets field number of the table to be processed.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ IndexDataRow		optional nillable	Gets prepared table row.
□ DataRowItems		optional 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		optional unbounded nillable
□ DateIndexData		optional 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	optional 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	optional 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	optional 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		optional 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	optional 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		optional 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	optional 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		optional 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	optional 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	optional 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	optional 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		optional 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	optional 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		optional 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	optional 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		optional nillable	Gets access mask for index data field (column) for connected user.
■ Value	xs:unsignedLong	optional	Represents the access mask of the permissions. See also: operation GetPermissionConstants.
□ DateTimeIndexData		optional 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	optional 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	optional 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	optional 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.
□ RowNo	xs:int	optional 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	optional nillable	Gets access status for the row for connected user.

Legend:

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