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 bulk request passed to ConfigurationRulesManager.modifyRules. The request is applied atomically in a single transaction in three phases: deletes first, then reorder, then adds and updates.
| 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(). |
| create |
Creates a new, empty ConfigurationRulesModifyInput. Populate rules, deleteRuleIds, and orderedRuleIds, then pass it to ConfigurationRulesManager.modifyRules. |
| Name | Description |
| deleteRuleIds | Gets and sets the ids of rules to delete. Deletes run before reorder and before adds/updates. Unknown ids produce a RULE_NOT_FOUND issue and the remaining ids are 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(): |
| orderedRuleIds | Gets and sets the desired final order of rule ids after deletes are applied. The list, when non-empty, must contain exactly one entry for every rule that remains after the delete phase. An empty array leaves the order unchanged. |
| rules | Gets and sets the rules to add or update on submit. Each rule's id field disambiguates: empty id ⇒ create a new rule on submit; non-empty id ⇒ update the existing rule with that id. After modifyRules returns, inspect the result's issues array to detect blocks that degraded to placeholders. The batch does NOT roll back on per-block validation failures; the rest of the rule (and the rest of the batch) applies even if individual get/set blocks are replaced. |
| 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. |