Tree.update (Method)

Updates an existing tree.

Returns:

TreeID (integer)

Arguments:

Name Type Required Description
id TreeID Required The ID of the tree.
name TreeName Required The name of the tree.
typeID TreeTypeID_0 Optional. Defaults to '0'. The unique ID of the tree type. If 0, then the default tree type is used.
familyID TreeFamilyID_0 Optional. Defaults to '0'. The family id of the tree. If 0, then no tree family is used.
description PlainText_2000 Optional. Defaults to an empty string. The description of the tree.
state ActiveInactive Optional. Defaults to 'Active'. The state of the tree, i.e. 'Active' or 'Inactive'.
properties Struct Optional. Defaults to '#StructNew()#'. A structure that describes all of the properties for the tree.

Context:

License Requirements (none)
Permission Requirements treeNav:Edit
Deny Context (none)
Require Context AuthoringEnabled
Author Lock (not required)
Transaction Logging If transaction logging is enabled at the site level, calls to this method will be logged
Customization Customization is not supported for this method.

Error Codes:

Code Error Message
403  
409  
87502 Another tree with the same name already exists.

Notes:

None