Show/Hide Toolbars

Therefore Web API Programming Interface 1.0

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

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

 

Returns tree of the categories.

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ AccessMask

 

nillable

DEPRECATED: Use the RoleAccessMask parameter instead. Set permissions the client needs to have for tree items to be returned. If value is not specified the AccessPermission mask will be used.

â–  Value

xs:unsignedLong

 

Represents the access mask of the permissions. See also: operation GetPermissionConstants.

â–¡ EmptyDocModesCriteria

 

nillable

Set category retrieving criteria based on the empty document mode setting of each category. If not set or empty all the categories will be returned.

≡ EmptyDocumentMode

 

list

restriction enum (xs:string)

- EmptyNotAllowed (0)

- EmptyAllowed (1)

- MustBeEmpty (2)


â–¡ RoleAccessMask

xs:unsignedLong

nillable

Sets the access mask of the permissions. See also: operation GetRolePermissionConstants. If not set the AccessMask parameter is used (or its default value).

 

 

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

 

Element Name

Element Type

Restrictions

Description

â–  parameters

 

 


â–¡ TreeItems

 

nillable

List of the root items of the category tree.

≡ WSCategoryTreeItem

 

list nillable


â–¡ ChildItems

 

nillable

Gets the list of children of this tree item.

â–  FolderType

xs:int

 

Gets the type for folder item object.

â–  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 a unique identifier of the item object.

â–  ItemNo

xs:int

 

Gets a unique number of the item object.

â–  ItemType

 

 

restriction enum (xs:string)

- Root (0)

- Folder (1)

- Category (2)

- CaseDefinition (3)

Gets type of the item object.

â–¡ Name

xs:string

nillable

Gets the name of the item object.

â–  ParentCaseDefNo

xs:int

 

Gets the number of parent case definition.

â–  ParentFolderNo

xs:int

 

Gets the number of a parent folder.

 

 

 

Legend:

 

â– 

Not nillable element.

â–¡

Nillable element.

≡

List of elements.

Bold

Mandatory element.

 

 

© 2023 Therefore Corporation, all rights reserved.