ConfigurationRulesManager.itemById Method

Parent Object: ConfigurationRulesManager

Preview This 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

Returns the rule with the specified id, along with any non-fatal issues from the read. Throws if the id is empty or does not match an existing rule; use itemByIds to get a RULE_NOT_FOUND issue instead of an exception for an unmatched id.

"configurationRulesManager_var" is a variable referencing a ConfigurationRulesManager object.

returnValue = configurationRulesManager_var.itemById(id)

"configurationRulesManager_var" is a variable referencing a ConfigurationRulesManager object.

#include <Fusion/ConfigurationRules/ConfigurationRulesManager.h>

returnValue = configurationRulesManager_var->itemById(id);

"configurationRulesManager_var" is a variable referencing a ConfigurationRulesManager object.

returnValue = configurationRulesManager_var.itemById(id);

Return Value

Type	Description
ConfigurationRuleResult	A ConfigurationRuleResult with the matched rule and any non-fatal issues from the read.

Parameters

Name	Type	Description
id	string	The id of the rule to return.

Samples

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