descendantLevels

The number of levels of navigation to expand, including the root level of the taxonomy.

Description

(Optional) A numeric value that provides instruction on the number of levels of child pages to expand in the navigation.

Values

  • a positive value greater than "1" - returns the specified number of levels of child pages, including the root node (category)
  • a value of "1" - returns all published taxonomy root nodes (categories) but no child pages
  • a negative value - returns an unlimited number of levels (the exact number used is irrelevant)

Default

1

Examples

The following are examples of descendantLevels used alone:

/api/navigation/subtree?descendantLevels=2
This example returns all taxonomy root nodes and their direct children (top-level keywords).
/api/navigation/subtree?descendantLevels=3
This example returns all taxonomy root nodes, their children (top-level keywords), and the children of those top-level keywords.
/api/navigation/subtree?descendantLevels=-1
This example returns all taxonomy root nodes and all of their descendants up to an unlimited number of levels.

The following are examples of descendantLevels used together with the Stemap Item ID:

/api/navigation/subtree/t2676?descendantLevels=2
This example returns the children (top-level Keywords) and children of those top-level Keywords (two levels of descendants) of taxonomy 2676 in the root Publication.
/api/navigation/subtree/t2676?descendantLevels=-1
This example returns the full taxonomy 2676 in the root Publication.

Note that this API's URLs are relative to the Publication's root URL.