Skip to main content

RuleCheck_Preview

**Experimental** Represents a rule check definition.

type RuleCheck_Preview {
actualErrorReportLevel: DesignDataErrorReportLevel_Preview!
defaultErrorReportLevel: DesignDataErrorReportLevel_Preview!
description: String
id: ID!
name: String!
type: RuleCheckType_Preview!
}

Fields

RuleCheck_Preview.actualErrorReportLevel ● DesignDataErrorReportLevel_Preview! non-null enum

**Experimental** The error level at which this rule check was actually executed. Defaults to the rule check's default level when the actual level is not known (e.g. legacy records).

RuleCheck_Preview.defaultErrorReportLevel ● DesignDataErrorReportLevel_Preview! non-null enum

**Experimental** The default error level at which violations are reported.

RuleCheck_Preview.description ● String scalar

**Experimental** The description of the rule check.

RuleCheck_Preview.id ● ID! non-null scalar

**Experimental** The unique identifier of the rule check.

RuleCheck_Preview.name ● String! non-null scalar

**Experimental** The name of the rule check.

RuleCheck_Preview.type ● RuleCheckType_Preview! non-null enum

**Experimental** The type of the rule check.