CategoryGetSpecialDocs
Returns the special document settings (exclusions, inclusions, and weighting factors) that have been set for a category. You can set special document settings by using the CategorySetSpecialDocs action.
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=CategoryGetSpecialDocs&Category=124365780934532
This action returns the explicitly excluded or included documents and their weighting factors for the category with the ID 124365780934532
.
Parameters
The following action parameters are required.
Parameter | Description |
---|---|
Category | The ID of the category to return special document settings for. |
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. |