|
GetCategoriesTree |
Scroll |
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 |
|
optional 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 |
optional |
Represents the access mask of the permissions. See also: operation GetPermissionConstants. |
â–¡ EmptyDocModesCriteria |
|
optional 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 |
|
optional unbounded restriction enum (xs:string) - EmptyNotAllowed (0) - EmptyAllowed (1) - MustBeEmpty (2) |
|
â–¡ RoleAccessMask |
xs:unsignedLong |
optional 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 |
|
optional nillable |
List of the root items of the category tree. |
≡ WSCategoryTreeItem |
|
optional unbounded nillable |
|
â–¡ ChildItems |
|
optional nillable |
Gets the list of children of this tree item. |
â– FolderType |
xs:int |
optional |
Gets the type for folder item object. |
â– Guid |
xs:string |
optional 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 |
optional |
Gets a unique number of the item object. |
â– ItemType |
|
optional restriction enum (xs:string) - Root (0) - Folder (1) - Category (2) - CaseDefinition (3) |
Gets type of the item object. |
â–¡ Name |
xs:string |
optional nillable |
Gets the name of the item object. |
â– ParentCaseDefNo |
xs:int |
optional |
Gets the number of parent case definition. |
â– ParentFolderNo |
xs:int |
optional |
Gets the number of a parent folder. |
Legend:
â– |
Not nillable element. |
â–¡ |
Nillable element. |
≡ |
Unbounded element (List of elements). |
Normal |
Optional element. |
Bold |
Mandatory element. |
