Tree.getNodeHierarchy (Method)
Returns an array of tree nodes and all it child nodes hierarchy.
Returns:
TreeNodeInfoStruct_Array (array)
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| id | TreeID | Required | The unique ID of a tree. |
| includeInactive | Boolean | Optional. Defaults to '0'. | Boolean flag which when set to true indicates that CommonSpot includes inactive nodes of the tree. |
| startingNodeID | TreeNodeID_0 | Optional. Defaults to '0'. | The ID of the tree node at which to start, or 0 for all nodes. Note if a non-zero nodeID is provided that node will not be included in the results. |
| maxDepth | NonNegativeInteger | Optional. Defaults to '0'. | The maximum number of levels to include in the results. A value of zero (0) will not restrict the results. |
Context:
| License Requirements | (none) |
| Permission Requirements | (none) |
| Deny Context | (none) |
| Require Context | (none) |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
| Code | Error Message |
|---|---|
| 409 |
Notes:
None