Allows you to return the IDs of all categories with a specified name. The name matching is case insensitive.
Note: This is an administrative action that can be sent only from AdminClients (which are set in the [Server]
section of the configuration file).
http://12.3.4.56:9000/action=CategoryFind&Name=Botanics
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 IDs of all categories that have the name Botanics
.
http://12.3.4.56:9000/action=CategoryFind&TaxonomyName=Medicines&Name=Botanics
This action instructs IDOL Category Component to return the IDs of all categories within the Medicines
taxonomy that have the name Botanics
.
Parameter | Description | Required |
---|---|---|
Name | The name of the category to find. | Yes |
Parent | The ID of the parent of the category to find. | |
Schema | The ID of a category that exists above the category that you want to find in the category hierarchy. | |
TaxonomyName | The name of a taxonomy that the category to find belongs to. | |
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. |
|