RuleViolation_Preview

**Experimental**

type RuleViolation_Preview {
  boundingRectangle: RuleViolationRectangle
  documentId: String
  errorReportLevel: String!
  errorText: String!
  location: RuleViolationLocation
  relatedObjects: [RuleViolationRelatedObject!]!
  ruleCheck: RuleCheckExecutionPart!
  ruleDescription: String @deprecated
  ruleFailureCode: String
  ruleName: String! @deprecated
  ruleNameWithVariant: String! @deprecated
  ruleType: String! @deprecated
  variantId: String
  variantName: String
}

Fields

RuleViolation_Preview.boundingRectangle ● RuleViolationRectangle object

**Experimental**

RuleViolation_Preview.documentId ● String scalar

**Experimental**

RuleViolation_Preview.errorReportLevel ● String! non-null scalar

**Experimental**

RuleViolation_Preview.errorText ● String! non-null scalar

**Experimental**

RuleViolation_Preview.location ● RuleViolationLocation object

**Experimental**

RuleViolation_Preview.relatedObjects ● [RuleViolationRelatedObject!]! non-null object

**Experimental**

RuleViolation_Preview.ruleCheck ● RuleCheckExecutionPart! non-null object

**Experimental**

RuleViolation_Preview.ruleDescription ● String deprecated scalar

DEPRECATED

Use ruleCheck.description instead.

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

RuleViolation_Preview.ruleFailureCode ● String scalar

**Experimental**

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! deprecated non-null scalar

DEPRECATED

Compose the rule name with variant instead.

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

RuleViolation_Preview.ruleType ● String! deprecated non-null scalar

DEPRECATED

Use ruleCheck.type instead.

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

RuleViolation_Preview.variantId ● String scalar

**Experimental**

RuleViolation_Preview.variantName ● String scalar

**Experimental**