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.
The typed result returned by ConfigurationRulesManager.getRules, ConfigurationRulesManager.itemByIds, and ConfigurationRulesManager.modifyRules. Carries the affected rule descriptors alongside any non-fatal issues from the same operation. An empty issues array means the call applied or read cleanly. Fatal errors (uninitialised rules pipeline, request-shape errors — plus, for modifyRules, a missing extension entitlement) throw an exception instead of being returned here. Reads (getRules, itemByIds) do not require the extension entitlement.
| Name | Description |
| classType |
Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType(). |
| Name | Description |
| issues | Non-fatal problems reported by the operation. Empty when the operation applied or read cleanly. Inspect this array after every modifyRules call — a VALIDATION_FAILED entry means the matching block silently degraded to an empty placeholder while the rest of the rule still applied. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| objectType | This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object. It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType(): |
| rules | The rules associated with the operation. For getRules and itemByIds these are the requested rules that were found. For modifyRules these are the post-mutation descriptors for rules that were added or updated (in the same order as the corresponding input rules), which is how callers recover server-assigned ids for new rules. When orderedRuleIds is set, the reordered rules are included as well. |
| 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. |