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

GetTreeViewChildNodesAndDocuments

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

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

Gets child nodes and documents of a given tree view

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

Element Name	Element Type	Restrictions	Description
■ parameters
■ IsIndexDataValuesNeeded	xs:boolean	optional	Sets to true if the index data values should be returned in the response.
□ NumberOfNestedLevels	xs:int	optional nillable	Sets maximum number of nested levels to be returned (with documents on these nodes).
□ PathList		optional nillable	Sets the path to the node.
≡ Path	xs:string	optional unbounded nillable
■ ViewNo	xs:int	mandatory	Sets the number of the tree view.
■ IsAccessMaskNeeded	xs:boolean	optional	Sets to true if the access mask for requested documents and index data fields should be returned in response.

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

Element Name	Element Type	Restrictions	Description
■ parameters
□ RootNodeForPath		optional nillable	Gets the tree of nodes for given path.
□ ChildNodes		optional nillable	Gets children of the node.
≡ WSTreeViewLevelNode		optional unbounded nillable
□ NodeValue	xs:string	optional nillable	Gets the value of the node.
□ Documents		optional nillable	Gets list of documents for given tree view node.
≡ WSDocInfo		optional unbounded nillable
■ CheckOutUserNo	xs:int	optional	Gets number of the user if the document is checked out.
■ Creation	xs:dateTime	optional	Gets document creation date.
■ DocSize	xs:unsignedLong	optional	Gets size of the document
□ Extension	xs:string	optional nillable	Gets file extension of the document.
□ IndexData		optional nillable	Gets index data info of the document.
■ CategoryNo	xs:int	mandatory	Gets the number of the category.
□ CtgryName	xs:string	optional nillable	Gets the name of the category.
■ DocNo	xs:int	optional	Gets the document number.
□ IndexDataItems		mandatory nillable	Gets index data items of the document.
≡ WSIndexDataItem		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.
□ MultipleKeywordData		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		mandatory nillable	Gets or sets multiple keyword values of the field.
≡ Keyword	xs:string	optional unbounded nillable
□ 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.
□ KeywordNos		optional nillable	Gets or sets multiple keyword numbers of the field.
≡ KeywordNo	xs:int	optional unbounded
□ 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.
□ TableIndexData		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		mandatory nillable	Gets or sets the table value of the field.
≡ WSTableFieldDataRow		optional unbounded nillable
□ 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
□ IntIndexData		optional nillable
□ LogicalIndexData		optional nillable
□ MoneyIndexData		optional nillable
□ SingleKeywordData		optional nillable
□ StringIndexData		optional nillable
□ AccessMask		optional nillable	Gets access mask for index data field (column) for connected user.
□ DateTimeIndexData		optional nillable
□ 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.
□ 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 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.
■ LastChangeTime	xs:dateTime	optional	Gets the timestamp when the index data was changed.
□ Title	xs:string	optional nillable	Gets the title of the document.
■ VersionNo	xs:int	optional	Gets the version number of the document.
■ Modified	xs:dateTime	optional	Gets document modification date.
■ Permissions	xs:unsignedLong	optional	Gets permission.

Legend:

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