RuleViolation

EXPERIMENTAL

Experimental

caution

Not production-ready. It may change or be removed without notice. See Lifecycle.

Represents a violation detected during a rule check execution.

Member Of

DesignDataCombinedErcCheckResult object ● RuleCheckAggregateExecution object ● RuleCheckExecution object

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

Fields

boundingRectangle ● RuleViolationRectangle object

The bounding rectangle of the violation in the design.

documentId ● String scalar

The identifier of the document where the violation occurred.

errorReportLevel ● String! non-null scalar

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

errorText ● String! non-null scalar

The error text describing the violation.

location ● RuleViolationLocation object

The location of the violation in the design.

relatedObjects ● [RuleViolationRelatedObject!]! non-null object

The design objects related to this violation.

ruleCheck ● RuleCheckExecutionPart! non-null object

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

ruleFailureCode ● String scalar

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.

variantId ● String scalar

The variant identifier for the violation.

variantName ● String scalar

The variant name for the violation.