Skip to main content

RuleViolation_Preview

**Experimental** Represents a violation detected during a rule check execution.

type RuleViolation_Preview {
  boundingRectangle: DesignDataRectangle_Preview
  documentId: String
  errorReportLevel: RuleViolationErrorReportLevel_Preview!
  errorText: String!
  location: DesignDataLocation_Preview
  relatedObjects: [RuleViolationRelatedObject_Preview!]!
  ruleCheck: RuleCheckPastDefinition_Preview!
  ruleDescription: String @deprecated
  ruleFailureCode: RuleFailureCode_Preview
  ruleName: String! @deprecated
  ruleNameWithVariant: String!
  ruleType: RuleCheckType_Preview! @deprecated
  variantId: String
  variantName: String
}

Fields​

RuleViolation_Preview.boundingRectangle ● DesignDataRectangle_Preview object​

**Experimental** The bounding rectangle of the violation in the design.

RuleViolation_Preview.documentId ● String scalar​

**Experimental** The identifier of the document where the violation occurred.

RuleViolation_Preview.errorReportLevel ● RuleViolationErrorReportLevel_Preview! non-null enum​

**Experimental** The error level of this violation.

RuleViolation_Preview.errorText ● String! non-null scalar​

**Experimental** The error text describing the violation.

RuleViolation_Preview.location ● DesignDataLocation_Preview object​

**Experimental** The location of the violation in the design.

RuleViolation_Preview.relatedObjects ● [RuleViolationRelatedObject_Preview!]! non-null object​

**Experimental** The design objects related to this violation.

RuleViolation_Preview.ruleCheck ● RuleCheckPastDefinition_Preview! non-null object​

**Experimental** The information about the rule check at the time the violation was reported.

RuleViolation_Preview.ruleDescription ● String deprecated scalar​

DEPRECATED

Use ruleCheck.description instead.

**Experimental** The description of the rule that was violated.

RuleViolation_Preview.ruleFailureCode ● RuleFailureCode_Preview enum​

**Experimental** The failure code if the rule check itself failed, rather than detecting a violation.

RuleViolation_Preview.ruleName ● String! deprecated non-null scalar​

DEPRECATED

Use ruleCheck.name instead.

**Experimental** The name of the rule that was violated.

RuleViolation_Preview.ruleNameWithVariant ● String! non-null scalar​

**Experimental** The name of the rule that was violated with variant if applicable.

RuleViolation_Preview.ruleType ● RuleCheckType_Preview! deprecated non-null enum​

DEPRECATED

Use ruleCheck.type instead.

**Experimental** The type of the rule that was violated.

RuleViolation_Preview.variantId ● String scalar​

**Experimental** The variant identifier for the violation.

RuleViolation_Preview.variantName ● String scalar​

**Experimental** The variant name for the violation.