IDOL Category Component 24.4
IDOL Category Component Help

# CategoryQuery

Allows you to query IDOL Category Component with a category.

## Example

    http://12.3.4.56:9020/action=CategoryQuery&Category=32349987602210557106

This action matches the category with the ID `32349987602210557106` against all its databases and return results that match the category training.

## Required Parameters

The following action parameters are required.

Parameter | Description
--- | ---
Category | The ID of the category to use to query.

## Optional Parameters

This action accepts the following optional parameters.

Parameter | Description
--- | ---
Databases | Restricts results to certain databases.
DocCountOnly | Return only the number of available results.
ExpandBoolean | Whether to expand Boolean category training in the category definition.
FieldText | A field restriction to apply to the category results.
MatchEncoding | Restricts results to documents with the specified encodings.
MatchLanguage | Restricts results to documents with the specified languages.
MatchLanguageType | Restricts results to documents with the specified language types.
NumResults | The number of results to return.
Params | Add `Query` action parameters to the category query.
Predict | Predicts the total number of results.
PrintFields | The fields to display in the results.
QueryText | Adds text to the category query, to return only results that match the category and text.
SecurityInfo | The security details for the user that sends the action.
Start | The number of the first result to return.
StoredStateDetail | Whether to return additional elements for result documents, as well as child server details, when the data index is a DAH.
StoreState | Whether to store results in a state token.
Threshold | The relevance threshold of results.
TotalResults | Whether to display the total number of hits found.
UserName | The name of the user that sends the action.
Values | Values for the specified Params.

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.4 | Last updated September 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.4

Topic Title: CategoryQuery