Skip to main content
View as Markdown

RuleViolation_Preview

EXPERIMENTAL

Experimental​

caution

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

No description

Member Of​

RuleCheckAggregateExecution_Preview object ● RuleCheckExecution_Preview object

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​

boundingRectangle ● RuleViolationRectangle object​

documentId ● String scalar​

errorReportLevel ● String! non-null scalar​

errorText ● String! non-null scalar​

location ● RuleViolationLocation object​

ruleCheck ● RuleCheckExecutionPart! non-null object​

ruleFailureCode ● String scalar​

variantId ● String scalar​

variantName ● String scalar​

Show deprecated

ruleDescription ● String deprecated scalar​

DEPRECATED

Use ruleCheck.description instead.

The description of the rule that was violated.

ruleName ● String! deprecated non-null scalar​

DEPRECATED

Use ruleCheck.name instead.

The name of the rule that was violated.

ruleNameWithVariant ● String! deprecated non-null scalar​

DEPRECATED

Compose the rule name with variant instead.

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

ruleType ● String! deprecated non-null scalar​

DEPRECATED

Use ruleCheck.type instead.

The type of the rule that was violated.