Category Component 25.3
Category Component Help

# CategoryFindByFields

Allows you to specify one or more field names and values to return the IDs of all categories that contain the specified values in the specified fields. The field 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.

You set the fields and values in Fields and Values. The number of field values specified must match the number of field names specified, and the order of the values must match the order of the names.

NOTE: You create user-defined fields in categories by using the CategorySetDetails action.

## Example

    http://12.3.4.56:9020/action=CategoryFindByFields&Fields=Author,Country&Values=Tolkien,UK

This action returns the IDs of all categories for which the field `Author` has the value `Tolkien` and the field `Country` has the value `UK`.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Fields | A comma-separated list of fields to match.
Values | A comma-separated list of field values to match.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
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 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: CategoryFindByFields