Name

Type

Description

targetNodeId

String

The ID of the node from which to start building the tree.

aggregateCollection

boolean

Indicates whether, for each node, to include all of the NavigationLink objects from the parent node.

If true, the NavigationLink objects in each collection type of the parent are also included in the collection of the same type in the child.

The links are contained in the navigationCollections field of the NavigationNode data type.

requiredCollections

String[]

Indicates which collection types to return.

See CollectionMapEntry for a list of collection types.

If null, all collection types are returned.

lastModification

Date

Indicates to return the navigation tree only if updates were made after the specified time.

If null, the navigation tree is returned.

environment

KeyValueEntry[]

For future use.

nodeAdditionalParams

String

Specifies additional parameters to return for each navigation node in the tree.

If no parameters are specified, only a small subset of available parameters are returned. See NavigationNode for the parameters that are automatically returned.

linkAdditionalParams

String[]

Specifies additional parameters to return for each NavigationLink in the tree.

The additional parameters are contained in the additionalAttributes field of the NavigationLink data type.

collectionAdditionalParams

String[]

Specifies additional parameters to return for each NavigationCollection in the tree.

The additional parameters are contained in the additionalAttributes field of the NavigationCollection data type.