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:

Example

http://12.3.4.56:9000/action=CategoryGetHierDetails

This action uses port 9000 to instruct IDOL Category Component, which is located on a machine with the IP address 12.3.4.56, to return the root category hierarchy details.

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

This action instructs IDOL Category Component to return details of the category hierarchy for the Recipe taxonomy.

Parameters

Parameter Description Required
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.
EncryptResponse Encrypt the output.
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.

_HP_HTML5_bannerTitle.htm