IDOL Category Component 24.2

# CategoryFind

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 by users that belong to an authorization role that allows the `Admin` standard role, or which enables the action explicitly. See Authorization Roles Configuration Parameters.

## Example

    http://12.3.4.56:9020/action=CategoryFind&Name=Botanics

This action returns the IDs of all categories that have the name `Botanics`.

    http://12.3.4.56:9020/action=CategoryFind&TaxonomyName=Medicines&Name=Botanics

This action returns the IDs of all categories in the `Medicines` taxonomy that have the name `Botanics`.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Name | The name of the category to find.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
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.
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 2024 Open Text
Version 24.2 | Last updated March 2024

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: IDOL IDOL Category Component 24.2

Topic Title: CategoryFind