Skip to main content

RuleCheckExecution

**Experimental** Represents the execution of rule checks against a design.

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​

RuleCheckExecution.designId ● ID scalar​

**Experimental** The identifier of the design being checked.

RuleCheckExecution.finishedAt ● DateTime scalar​

**Experimental** The time when the execution finished, if finished.

RuleCheckExecution.id ● ID! non-null scalar​

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

RuleCheckExecution.parts ● [RuleCheckExecutionPart!]! non-null object​

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

RuleCheckExecution.reason ● String! non-null scalar​

**Experimental** 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.

RuleCheckExecution.revisionId ● String! non-null scalar​

**Experimental** The design revision identifier associated with the execution.

RuleCheckExecution.source ● String! non-null scalar​

**Experimental** 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.

RuleCheckExecution.startedAt ● DateTime! non-null scalar​

**Experimental** The time when the execution started.

RuleCheckExecution.startedByUserId ● String! non-null scalar​

**Experimental** The identifier of the user who started the execution.

RuleCheckExecution.status ● String! non-null scalar​

**Experimental** 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.

RuleCheckExecution.uploadId ● String scalar​

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

RuleCheckExecution.violations ● [RuleViolation!]! non-null object​

**Experimental** The list of violations found during execution.