Category Component 25.3
Category Component Help

# CategoryGetHierDetails

Returns the hierarchy details for a specified category (by default it returns the root category, which has the category ID `0`). This action returns the following information:

- the name and ID of the category

- the depth of the category in the hierarchy

- the location of the category in the hierarchy

- the number of children the category has

- the names and IDs of all the children of the category

## Example

    http://12.3.4.56:9020/action=CategoryGetHierDetails

This action returns the root category hierarchy details.

    http://12.3.4.56:9020/action=CategoryGetHierDetails&TaxonomyName=Recipe

This action returns details of the category hierarchy for the `Recipe` taxonomy.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Category | The ID of the category to return hierarchy details for.
Expand | The categories to expand in the hierarchy.
Fields | The category fields to display.
PrintFields | Displays fields that have been set for the category.
Schema | The ID of the category that acts as the virtual root.
TaxonomyName | The name of a taxonomy to get details for.
UserName | The name of the user that sends the action.

This action accepts the following standard ACI action parameters.

Parameter | Description
--- | ---
ActionID | A string to use to identify an ACI action.
FileName | The file to write output to.
ForceTemplateRefresh | Forces the server to load the template from disk.
Output | Writes output to a file.
ResponseFormat | The format of the action output.
Template | The template to use for the action output.
TemplateParamCSVs | A list of variables to use for the specified template.

Copyright 2025 Open Text
Version 25.3 | Last updated July 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Category Component 25.3

Topic Title: CategoryGetHierDetails