RuleCheckExecution

EXPERIMENTAL

Experimental

caution

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

Represents the execution of rule checks against a design.

Common Data Model

• Rule Check Execution — Execution of a rule check against a project to validate design integrity and compliance with specified constraints.
  • IRI: https://w3id.org/altium/cdm/design/RuleCheckExecution
  • GRID: grid:workspace:{workspace-id}:design:rule-check-execution/{id}

Returned By

design.ruleCheckExecution.byDesignId query ● design.ruleCheckExecution.byId query ● design.ruleCheckExecution.byIds query ● design.ruleCheckExecution.byReleaseId query

Member Of

DesignRuleCheckExecuteOnUploadPayload object ● DesignRuleCheckExecutePayload object ● RuleCheckAggregateExecution object

type RuleCheckExecution {
  designId: ID
  finishedAt: DateTime
  id: ID!
  parts: [RuleCheckExecutionPart!]!
  reason: String!
  revisionId: String!
  source: String!
  startedAt: DateTime!
  startedByUserId: String!
  status: String!
  uploadId: String
  violations: [RuleViolation!]!
}

Fields

designId ● ID scalar

The identifier of the design being checked.

finishedAt ● DateTime scalar

The time when the execution finished, if finished.

id ● ID! non-null scalar

The unique identifier of the rule check execution.

parts ● [RuleCheckExecutionPart!]! non-null object

The list of rule checks executed as part of this execution, with their definition at the time of execution and their current status.

reason ● String! non-null scalar

Reason why the rule check execution was triggered, which can be used for filtering and distinguishing different types of rule check executions. Known values: CHANGE, PROCESS, REGENERATION, RELEASE_CANDIDATE, RELEASE, UPLOAD. New values may be added; clients must tolerate unknown values.

revisionId ● String! non-null scalar

The design revision identifier associated with the execution.

source ● String! non-null scalar

Source of the rule check execution, identifying whether it was triggered by a user or by the system. Known values: SYSTEM, USER. New values may be added; clients must tolerate unknown values.

startedAt ● DateTime! non-null scalar

The time when the execution started.

startedByUserId ● String! non-null scalar

The identifier of the user who started the execution.

status ● String! non-null scalar

The current status of the rule check execution. Known values: PENDING, RUNNING, COMPLETED, FAILED, SKIPPED. New values may be added; clients must tolerate unknown values.

uploadId ● String scalar

Identifier of the upload, when the rule check execution targets a custom uploaded design.

violations ● [RuleViolation!]! non-null object

The list of violations found during execution.