RuleCheck

EXPERIMENTAL

Experimental

caution

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

Represents a rule check definition.

Common Data Model

• Rule Check — Rule check definitions that can be executed against a project to validate design integrity and compliance with specified constraints.
  • IRI: https://w3id.org/altium/cdm/design/RuleCheck
  • GRID: grid:workspace:{workspace-id}:design:rule-check/{id}

Returned By

design.preview.ruleCheckById query ● design.preview.ruleChecksByAuth query ● design.preview.ruleChecksByIds query ● design.ruleCheck.byAuth query ● design.ruleCheck.byId query ● design.ruleCheck.byIds query

Member Of

RuleCheckExecutionPart object

type RuleCheck {
  actualErrorReportLevel: String!
  defaultErrorReportLevel: String!
  description: String
  id: ID!
  name: String!
  type: String!
}

Fields

actualErrorReportLevel ● String! non-null scalar

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). Known values: NO_REPORT, WARNING, ERROR, FATAL. New values may be added; clients must tolerate unknown values.

defaultErrorReportLevel ● String! non-null scalar

The default error level at which violations are reported. Known values: NO_REPORT, WARNING, ERROR, FATAL. New values may be added; clients must tolerate unknown values.

description ● String scalar

The description of the rule check.

id ● ID! non-null scalar

The unique identifier of the rule check.

name ● String! non-null scalar

The name of the rule check.

type ● String! non-null scalar

The type of the rule check. Known values: ERC, DRC. New values may be added; clients must tolerate unknown values.