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.
One non-fatal problem reported by a ConfigurationRulesManager operation. A non-empty issues array on ConfigurationRulesResult means one or more rules need attention; fatal errors throw an exception instead.
| 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 |
| code | The code identifying the kind of problem. Stable string values include "VALIDATION_FAILED" (a get/set block did not pass semantic validation and was replaced with an empty placeholder), "RULE_NOT_FOUND" (a delete-id or itemByIds filter did not match an existing rule), "DELETE_FAILED" (a delete failed server-side), "CREATE_FAILED" (a new rule could not be created), "CONVERSION_WARNING" (read-back hit a non-fatal conversion problem). Additional codes may be returned by future server versions; treat unknown codes as opaque strings. |
| columnId | The id of the column the issue applies to. Empty when the issue is not tied to a specific column. |
| hasRuleIndex | True when ruleIndex carries a meaningful value; false for issues that are not tied to a specific request rule. |
| isValid | Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference. |
| message | A human-readable message describing the problem. Suitable for surfacing to developers; not localised. |
| 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(): |
| path | A dotted path locating the part of the request that triggered the issue, such as "rules[0].body[2]" or "rules[0].body[1].condition.left". Empty if the issue is not tied to a specific path. |
| ruleId | The id of the rule the issue applies to. Empty for issues that are not tied to a single rule (e.g. ReorderCountMismatch which affects the request as a whole). |
| ruleIndex | The zero-based index of the rule in the request that the issue applies to. Read only when hasRuleIndex is true. Use ruleIndex rather than parsing path to correlate an issue back to a request rule. |
| 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. |