PreprocessIndexData |
Scroll |
REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/PreprocessIndexData
SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/PreprocessIndexData
Returns index data for given category (with default values, filled dependent fields, or with ix data for autoappend, and updated calculated fields).
Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/PreprocessIndexData
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â–¡ CaseDefinitionNo |
xs:int |
nillable |
Sets the case definition number. The CategoryNo and CaseDefinitionNo are mutually exclusive, only one should be set. |
â–¡ CategoryNo |
xs:int |
nillable |
Sets the category number. The CategoryNo and CaseDefinitionNo are mutually exclusive, only one should be set. |
â– ExcludeReduntantForFillDependentFields |
xs:boolean |
|
Set it to True to exclude redundand fields while filling dependent fields. Note: "True" value is usualy used when preparing index data for search and "False" - for editing/saving. Default value is False. |
â– FillDependentFields |
xs:boolean |
|
Set it to True to fill dependent fields. |
â– GetAutoAppendIxData |
xs:boolean |
|
Set it to True to get auto-append index data. |
â–¡ IndexData |
|
nillable |
Sets index data to be processed. Can be ommitted in case (for example) you just want to get default values for a category/case definition. |
â–¡ IndexDataItems |
|
mandatory nillable |
Sets the index data field's values. |
≡ 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. |
â– LastChangeTime |
xs:dateTime |
|
Is a timestamp that displays when the index data was changed. Is used to avoid conflicting changes and data lost. Should be taken from previous the operation on this document (for example GetCase/GetDocument operation). LastChangeTimeISO8601 parameter can be used instead of LastChangeTime parameter . If LastChangeTime is set the value in LastChangeTimeISO8601 is ignored. |
â–¡ DoFillDependentFields |
xs:boolean |
nillable |
Set to true or false to explicitly execute or skip FillDependentFields step while writing index data. If not set or null the old behavior will be used. That means the FillDependentFields step will be executed. Note: In order to update primary and dependent fields you can: 1. specify both values (for primary and dependent) or just for primary. In this case primary field will be used to lookup related value(s) for dependent field(s). Value of dependent field(s) from the request will be ignored. 2. specify value of dependent field(s) only. In this case if a unique primary field (related to given dependent field(s)) can be found it will be used. Otherwise, if there are many values found for primary field an error will be returned. |
â–¡ LastChangeTimeISO8601 |
xs:string |
nillable |
Sets the timestamp (in ISO 8601 format, UTC) when the index data was changed. LastChangeTimeISO8601 parameter can be used instead of LastChangeTime parameter . If LastChangeTime is set the value in LastChangeTimeISO8601 is ignored. |
â– ResetToDefaults |
xs:boolean |
|
Set it to True to reset index data to default values. The IndexData property in the request can be omitted. |
â–¡ DoCalculateFields |
xs:boolean |
nillable |
Set to true or false to explicitly execute or skip the CalculateFields step while writing index data. By default fields are calculated. |
â–¡ FileUploadSessionId |
xs:string |
nillable GUID string template: [\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12} |
Set upload session ID of the first file to be used to resolve all file-based macros. All the file chunks MUST be uploaded (see the UploadSessionAppendChunk method) for the provided session. |
Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/PreprocessIndexDataResponse
Element Name |
Element Type |
Restrictions |
Description |
â– parameters |
|
|
|
â–¡ IndexData |
|
nillable |
Gets processed index data. |
â– CategoryNo |
xs:int |
mandatory |
Gets the number of the category. |
â–¡ CtgryName |
xs:string |
nillable |
Gets the name of the category. |
â– DocNo |
xs:int |
|
Gets the document number. |
â–¡ IndexDataItems |
|
mandatory nillable |
Gets index data items of the document. |
≡ 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. |
â– LastChangeTime |
xs:dateTime |
|
Gets the timestamp when the index data was changed. |
â–¡ Title |
xs:string |
nillable |
Gets the title of the document. |
â– VersionNo |
xs:int |
|
Gets the version number of the document. |
â– CaseDefinitionNo |
xs:int |
|
Gets the number of the case definition. |
â– CaseNo |
xs:int |
|
Gets the number of the case. |
â–¡ LastChangeTimeISO8601 |
xs:string |
nillable |
Gets the timestamp (in ISO 8601 format, UTC) when the index data was changed. |
â–¡ CalculationResult |
|
nillable |
Gets result of calculations process for calculated fields. |
â–¡ Items |
|
nillable |
Gets the calculation result items. |
≡ ResultItem |
|
list nillable |
|
â– FieldNo |
xs:int |
|
Gets number of the field. |
â– RowNo |
xs:int |
|
Gets number of the row for table fields. |
â– Status |
|
restriction enum (xs:string) - CalculationSuccess (0) - DivisionByZero (1) - CalculationValueOutOfRange (2) - UnknownCalculationError (3) - CalculationFieldNotFound (4) - OtherCalculationError (5) - CalculationUnsupported (6) - CalculationSetIndexDataError (7) - CalculationFormattingError (8) |
Gets calculation result status. |
Legend:
â– |
Not nillable element. |
â–¡ |
Nillable element. |
≡ |
List of elements. |
Bold |
Mandatory element. |