ConfigurationRulesManager.addRule Method

Parent Object: ConfigurationRulesManager

PreviewThis functionality is provided as a preview of intended future API capabilities. You are encouraged to use it and report any problems or suggestions using the Fusion API and Scripts forum.

Because this is a preview of future functionality, there is the possibility that it will change, which will possibly break any existing programs that use this functionality. Because of that, you should never deliver any programs that use any preview capabilities. For a distributed program, you should wait until it has moved from preview to released state.


Defined in namespace "adsk::fusion" and the header file is <Fusion/ConfigurationRules/ConfigurationRulesManager.h>

Description

Creates a single new rule with the given name, an empty body, and isActive = true. This is a shortcut equivalent to building a ConfigurationRulesModifyInput with one added rule and calling modifyRules; use it when you only need to add one rule and do not need to batch other changes. Use ConfigurationRule.create + modifyRules when you need to populate the body before submitting. The new rule's comment is seeded with a default placeholder rather than left empty.

Syntax

"configurationRulesManager_var" is a variable referencing a ConfigurationRulesManager object.

returnValue = configurationRulesManager_var.addRule(name)
"configurationRulesManager_var" is a variable referencing a ConfigurationRulesManager object.

#include <Fusion/ConfigurationRules/ConfigurationRulesManager.h>

returnValue = configurationRulesManager_var->addRule(name);
"configurationRulesManager_var" is a variable referencing a ConfigurationRulesManager object.

returnValue = configurationRulesManager_var.addRule(name);

Return Value

Type Description
ConfigurationRuleResult A ConfigurationRuleResult with the created rule and any non-fatal issues. Like modifyRules, issues do not mean the rule was not created.

Parameters

Name Type Description
name string The user-visible name of the new rule.

Samples

Name Description
Configuration Rules API Sample

Demonstrates reading and modifying configuration rules using the typed ConfigurationRules API.

Before running: Run in the DESIGN workspace from Scripts and Add-Ins (Python, C++, or TypeScript), unless the script states otherwise.

Version

Introduced in version October 2026