Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Gets a list of tree view items for specific permissions.

 

 

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

 

Element Name

Element Type

Restrictions

Description

β–  parameters

 

 


β–  Permissions

 

mandatory

restriction flag (xs:string)

β˜‘ IgnorePermissions (0)

β˜‘ OperatorPermission (1)

β˜‘ AdminPermission (2)

β˜‘ SetPermPermission (4)

β˜‘ AccessPermission (8)

β˜‘ TheSystemConnectPermission (16)

β˜‘ TheSystemWritePermission (32)

β˜‘ CategoryArchivePermission (64)

β˜‘ QueryAdminPermission (128)

β˜‘ QueryExecutePermission (256)

β˜‘ QueryCtgrytabsPermission (512)

β˜‘ KeywordDictionaryChangePermission (1024)

β˜‘ QueryTemplatesReadPermission (2048)

β˜‘ DocViewinHitListPermission (4096)

β˜‘ DocViewDocPermission (8192)

β˜‘ DocPrintPermission (16384)

β˜‘ DocExportSendPermission (32768)

β˜‘ DocViewAnnotationPermission (65536)

β˜‘ DocHideAnnotationPermission (131072)

β˜‘ DocViewHistoryPermission (262144)

β˜‘ WfParticipatePermission (262144)

β˜‘ DocAddAnnotationsPermission (524288)

β˜‘ WfAddDocPermission (524288)

β˜‘ DocDeleteAnnotationsPermission (1048576)

β˜‘ WfViewHistoryPermission (1048576)

β˜‘ DocEditPermission (2097152)

β˜‘ WfDelegatePermission (2097152)

β˜‘ DocUpdateIndexDataPermission (4194304)

β˜‘ WfViewAllPermission (4194304)

β˜‘ DocAddPagePermission (8388608)

β˜‘ WfDeletePermission (8388608)

β˜‘ DocDeletePagePermission (16777216)

β˜‘ DocDeleteDocPermission (33554432)

β˜‘ CategoryFieldReadPermission (268435456)

β˜‘ CategoryFieldSetPermission (536870912)

β˜‘ CategoryFieldChangePermission (1073741824)

Sets the permission to search for.

 

 

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

 

Element Name

Element Type

Restrictions

Description

β–  parameters

 

 


β–‘ TreeViewList

 

nillable

Gets tree view item list.

≑ WSTreeViewItem

 

list nillable


β–  CategoryNo

xs:int

 

Gets the category number of the item.

β–  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 the tree item GUID.

β–‘ LevelsDefinition

 

nillable

Gets the level definition of the tree view item.

≑ WSTreeViewLevelDefinition

 

list nillable


β–  FieldNo

xs:int

 

Gets the field number.

β–‘ FuncParam

xs:string

nillable

Gets the parameters.

β–  Function

 

 

restriction enum (xs:string)

- NoFunction (0)

- Month (1)

- Year (2)

- MonthYear (3)

- FirstChar (4)

- FirstCharGroup (5)

- Range (6)

Gets the level function.

β–  IsLastLevel

xs:boolean

 

Returns 'true' for the last level.

β–  LevelNo

xs:int

 

Gets the level number.

β–  SortOrder

 

 

restriction enum (xs:string)

- Ascending (1)

- Descending (2)

Gets the sort order.

β–  ViewNo

xs:int

 

Gets the view number.

β–‘ Name

xs:string

nillable

Gets the name of the item.

β–  ViewNo

xs:int

 

Gets the view number.

 

 

 

Legend:

 

β– 

Not nillable element.

β–‘

Nillable element.

≑

List of elements.

Bold

Mandatory element.

 

 

Β© 2024 Therefore Corporation, all rights reserved.