Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

Therefore Web API > Web API Reference > Operations

GetTreeViewChildNodesAndDocuments

Scroll

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

 

Sets to true if the index data values should be returned in the response.

â–¡ NumberOfNestedLevels

xs:int

nillable

Sets maximum number of nested levels to be returned (with documents on these nodes).

â–¡ PathList

 

nillable

Sets the path to the node.

≡ Path

xs:string

list nillable


â–  ViewNo

xs:int

mandatory

Sets the number of the tree view.

â–  IsAccessMaskNeeded

xs:boolean

 

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

 

nillable

Gets the tree of nodes for given path.

â–¡ ChildNodes

 

nillable

Gets children of the node.

≡ WSTreeViewLevelNode

 

list nillable


â–¡ NodeValue

xs:string

nillable

Gets the value of the node.

â–¡ Documents

 

nillable

Gets list of documents for given tree view node.

≡ WSDocInfo

 

list nillable


â–  CheckOutUserNo

xs:int

 

Gets number of the user if the document is checked out.

â–  Creation

xs:dateTime

 

Gets document creation date.

â–  DocSize

xs:unsignedLong

 

Gets size of the document

â–¡ Extension

xs:string

nillable

Gets file extension of the document.

â–¡ IndexData

 

nillable

Gets index data info of the document.

â–  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


â–¡ IntIndexData

 

nillable


â–¡ LogicalIndexData

 

nillable


â–¡ MoneyIndexData

 

nillable


â–¡ SingleKeywordData

 

nillable


â–¡ StringIndexData

 

nillable


â–¡ AccessMask

 

nillable

Gets access mask for index data field (column) for connected user.

â–¡ DateTimeIndexData

 

nillable


â–¡ RoleAccessMask

 

nillable

Gets the role access mask for index data field(column) for connected user.

â–¡ 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.

â–  Modified

xs:dateTime

 

Gets document modification date.

â–  Permissions

xs:unsignedLong

 

Gets permission.

â–¡ CreationISO8601

xs:string

nillable

Gets document creation date (in ISO 8601 format, UTC).

â–¡ ModifiedISO8601

xs:string

nillable

Gets document modification date (in ISO 8601 format, UTC).

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2024 Therefore Corporation, all rights reserved.