Skip to main content

RuleViolation

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

type RuleViolation {
  boundingRectangle: RuleViolationRectangle
  documentId: String
  errorReportLevel: String!
  errorText: String!
  location: RuleViolationLocation
  relatedObjects: [RuleViolationRelatedObject!]!
  ruleCheck: RuleCheckExecutionPart!
  ruleFailureCode: String
  variantId: String
  variantName: String
}

Fields​

RuleViolation.boundingRectangle ● RuleViolationRectangle object​

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

RuleViolation.documentId ● String scalar​

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

RuleViolation.errorReportLevel ● String! non-null scalar​

**Experimental** The error level of this violation. Known values: SKIPPED, WARNING, ERROR, FATAL. New values may be added; clients must tolerate unknown values.

RuleViolation.errorText ● String! non-null scalar​

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

RuleViolation.location ● RuleViolationLocation object​

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

RuleViolation.relatedObjects ● [RuleViolationRelatedObject!]! non-null object​

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

RuleViolation.ruleCheck ● RuleCheckExecutionPart! non-null object​

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

RuleViolation.ruleFailureCode ● String scalar​

**Experimental** The failure code if the rule check itself failed, rather than detecting a violation. Known values: INTERNAL_SERVER_ERROR, UNHANDLED_EXCEPTION_FROM_USER_SCRIPT, INVALID_RETURN_VALUE_FROM_USER_SCRIPT. New values may be added; clients must tolerate unknown values.

RuleViolation.variantId ● String scalar​

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

RuleViolation.variantName ● String scalar​

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